schlittermann

Einige Vorgaben für die Formatierung von PHP-Quelltexten
    Textbreite, Seitenlänge, Tabstops etc.
    Leerzeichen
    Einrückungen
    Klammern
    Programmiertechnik
        Zeichenketten
        HERE-Dokumente

Heute (2006-09-14) habe ich etwas gefunden: http://pear.php.net/manual/de/standards.php, somit brauche ich wahrscheinlich hier nicht weiter zu schreiben.

Einige Vorgaben für die Formatierung von PHP-Quelltexten

Das sollen einige Vorgaben für die Formatierung von Quelltext sein. Abweichungen im Sinne der Lesbarkeit sind natürlich immer möglich.

Textbreite, Seitenlänge, Tabstops etc.

Wenn möglich sollten die einzelnen Zeilen nicht länger als 80 Zeichen sein.

Wenn eine Seite länger als 1000 Zeilen wird, ist es an der Zeit über das Auslagern von Teilen der Seite nachzudenken (Strukturierung!).

Tabulatorweite für das Einrücken ist 4 Zeichen (vorzugsweise sog. Soft-Tabs).

Leerzeichen

Es gelten die Leerzeichenregeln der normalen Schriftsprache, also nach einem Satzzeichen folgt ein Leerzeichen:

// Das ist Kommentar
print("Vater", "Mutter", "Kind"); die(2);

Um alle binären und ternären Operatoren kommt jeweils ein Leerzeichen:

$th = cgi("th");
$page = "<table>...</table>";
$a = $b + $c;
$y += 7;
$z = $answer == "yes" ? 42 : 0;

PHP und HTML sind nun mal vermischt, besser wäre es natürlich Templates und ähnliches zu verwenden. Da diese Vermengung von PHP offenbar gewollt ist und ja leidlich gut unterstützt wird, sollten wir trotzdem versuchen einige Regeln einzuhalten.

Es gibt keinen Grund, PHP zu verwenden, wenn es purer HTML-Text auch tut. Also statt etlicher echos lieber mal den PHP-Block beenden und HTML machen.