PHP Programmierstil

[faux]

Hallo!

Ich programmiere zwar schon seit ein paar Jahren in PHP, aber dennoch wollte ich mal fragen, ob mein Programmierstil leserlich ist und was man daran noch verbessern kann, da ich einige meiner Skripte auch auf meiner Homepage veröffentliche und diese dann auch von anderen Programmierern eingesehen werden können sollen, ohne dass er sich über den Stil ärgern muss.
Ich hänge mal eine Datei an und habe diese auch auf http://phpfi.com/111701 geladen, falls jemand keinen PHP Highlighter bei der Hand hat, oder die Datei nicht laden will.

Danke für eure Rückmeldungen
Grüße
Faux

NACHTRAG:
Bitte macht mich nicht auf fehlende Kommentare aufmerksam, ich weiß, dass das zu einem guten Stil gehört.

[Flare]

Doch sieht gut aus
Wobei ich (aber ich glaube nur ich) eher auf deutsche Variablennamen ausweichen würde. So erkenne ich schneller welche Variablen von mir sind und welche vom System.
Wie du schon sagtest fehlen leider Kommentare, aber die lasse ich auch meistens weg. Allerdings sollte man vielleicht doch welche reinsetzen damit der Betrachter etwas schneller hinter den Code kommt.


Flare

[S2B]

Naja, den Programmierstil kann man immer nur subjektiv bewerten, also hier meine Meinung: Ich finde den Code ehrlich gesagt nicht wirklich übersichtlich. Vor allem bei den if-Schleifen habe ich Probleme nachzuvollziehen, was denn jetzt wann gemacht wird.
Ich halte es mit if-Schleifen immer so, dass ich grundsätzlich geschweifte Klammern verwende und diese auch immer in eine neue Zeile schreibe:

Code:

if ($variable == 'test')
{
  echo 'Variable enthält "test"';
}
else
{
  // sonst was...
}

Im Prinzip kann ich sagen, dass ich mich nahezu komplett an die Coding Guidelines vom neuen phpBB halte, vielleicht findest du ja dort auch noch den einen oder anderen Tipp.

[faux]

Zitat von Flare:

Wobei ich (aber ich glaube nur ich) eher auf deutsche Variablennamen ausweichen würde. So erkenne ich schneller welche Variablen von mir sind und welche vom System.

Hm.. Ich finde, das klingt dann etwas seltsam: $anfrage_abstimmungen anstatt von $query_votes *g*
Naja, wie S2B schon gesagt hat, man kanns nur subjektiv beantworten.

Stimmt. Kommentare sind sicherlich nicht fehl am Platz.

Zitat von S2B:

Vor allem bei den if-Schleifen habe ich Probleme nachzuvollziehen, was denn jetzt wann gemacht wird.

Also diese Art von Schleifen kenne ich noch garnicht: if-Schleifen...
Aber ja, du hast recht. Das habe ich mir in C# auch schon angewöht, keine Ahnung wieso ich das in PHP nicht mache. Naja, platzraubend ist es schon sehr.

Zitat von S2B:

Im Prinzip kann ich sagen, dass ich mich nahezu komplett an die Coding Guidelines vom neuen phpBB halte, vielleicht findest du ja dort auch noch den einen oder anderen Tipp.

Werde ich mir mal ansehen. Danke.

Grüße
Faux

[S2B]

Zitat von faux:

Also diese Art von Schleifen kenne ich noch garnicht: if-Schleifen...

*grml*
Wie heißt das denn richtig?

Zitat von faux:

Naja, platzraubend ist es schon sehr.

Vor einiger Zeit habe ich mir angewöhnt, nicht mehr auf den Platz zu achten, sondern allein auf die Lesbarkeit...

[Elvis]

Zitat von S2B:

Zitat von faux:

Also diese Art von Schleifen kenne ich noch garnicht: if-Schleifen...

*grml*
Wie heißt das denn richtig?

Statements, clauses, Klauseln, Blöcke, Erdbeerkuchen,...

btw: Wenn du etwas camelCasing statt ekelhafter Unterstriche nehmen würdest, könnte ich es sogar zu Ende lesen ohne panikartig ctrl+F4 zu drücken...

[S2B]

Zitat von Elvis:

btw: Wenn du etwas camelCasing statt ekelhafter Unterstriche nehmen würdest, könnte ich es sogar zu Ende lesen ohne panikartig ctrl+F4 zu drücken...

Ansichtssache. Meiner Meinung nach sind die Unterstriche die Leerzeichen des Programmierers. *g*

[Airblader]

Nun,
auch ich bewerte nach meinem Stil:

An sich sidn Einrückungen etc. schon lobenswert (da leider nicht selbstverständlich).
Was mir nicht so gefallen mag ist:

Variablen / Funktionsnamen
Deine Namen sagen immerhin schon etwas aus, aber ich persönlich würde sie noch aussagekräftiger gestalten.
Wenn sie sich aus Wörtern zusammensetzen ("$meinevar"), so kennzeichne ich das auch: $meineVar.
Ich gehe dann aber noch einen Schritt weiter und setze ein Präfix, der etwas über den Typ der Variable aussagt.
Wäre $meineVar also z.B. ein Boolean(String), würde es auch so heißen: $bMeineVar ($sMeineVar).

Absätze
Ich persönlich würde öfters mal die ENTER-Taste betätigen. Für mich symbolisieren Absätze die Trennung von zusammengehörigen Codes. Beispiel:

Code:

    if ($this->connection && DEBUG == 1)
      echo "\n";
    elseif (DEBUG == 1)
      echo "\n";
    $change = mysql_select_db($_CONFIG['db'], $this->connection);
    if ($change && DEBUG == 1)
      echo "\n";
    elseif (DEBUG == 1)
      echo "\n";

=>

Code:

    if ($this->connection && DEBUG == 1)
      echo "\n";
    elseif (DEBUG == 1)
      echo "\n";

    $change = mysql_select_db($_CONFIG['db'], $this->connection);

    if ($change && DEBUG == 1)
      echo "\n";
    elseif (DEBUG == 1)
      echo "\n";

Kommentare
Für mich das Stilkennzeichen schlechthin. Wenn mal andere Leute ins Team kommen und sich einarbeiten müssen, haben sie ohne Kommentare keine Chance dazu (*aus Erfahrung sprech*). Außerdem machen sie jeden Code übersichtlich und lassen schnell erkennen, worum es geht (so kann man sich die Zeit sparen, den Code zu lesen und zu interpretieren, was dort nun nochmal gemacht wird).
Bei größeren Scripts sind Kommentare auch für eine einzelne Person (über-)lebenswichtig (*wieder aus Erfahrung sprech*).
Sinnlose Kommentare bei Stellen wie "$i++;" o.ä. muss man natürlich nicht setzen

Ansonsten mache ich noch ganz gern folgendes:
An den Anfang jeder Datei eine kurze Erklärung:

• Von wann ist die Datei?
• Evtl. Neuerungen / Fixes (mit Datum)
• Autor
• Inhalt und Funktion
• ... (evtl. andere wichtige Informationen)

Wie gesagt - alles nur subjektiv!

air

[Matze]

Hi,

also deine if-Abfragen (auch genannt Erdbeerkuchen @Elvis ) sind graußlich, sorry, das ist ja nur unübersichtlich.

Ich formatiere auch generell meinen php-Code und zeige dir, wie ich das mache. Dein Code formatiert. Falls ich das vom Server nehmen soll, dann sag es bitte und ich schmeiß es runter.

[Neuni]

Mal so nebenbei: Gibts ein Programm dass das ganze übersichtlich darstellt?
So wie im Firefox mit dem HTML-code wenn man den "bereinigt".