Einzelnen Beitrag anzeigen

Benutzerbild von Airblader
Airblader

Registriert seit: 29. Okt 2004
Ort: Geislingen an der Steige
742 Beiträge
 
#8

Re: PHP Programmierstil

  Alt 9. Apr 2006, 19:10
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
Ingo Bürk
Es nimmt der Augenblick, was Jahre geben.

Johann Wolfgang von Goethe
  Mit Zitat antworten Zitat