Programmier-Konventionen: Formatierung

Einzug
Die logische Gestaltung des Codes mit Einzügen ist für die Übersichtlichkeit elementar. Ob dabei vier Leerzeichen oder Tabs verwendet werden muss abgemacht werden.
Grundsätzlich gilt: Sobald die geschweiften Klammern {} auftreten, muss der zwischen den Klammern liegende Code um eine Stufe eingerückt werden. Die Klammern werden nicht eingerückt.

geschweifte Klammern {}
Die geschweiften Klammern sind bei Funktionen, Methoden und Klassen auf eine neue Zeile zu setzen. Bei if-, else-, while-, foreach-, for-, switch-Schlaufen etc. kann die einführende Klammer auf der gleichen Zeile stehen.

sonstige Klammern () und []
Es werden nur Klammern gesetzt, wo sie zwingend nötig sind.

Leerzeichen
Vor und nach dem Definitionsoperator "=" und den Vergleichsoperatoren "==", ">", "<", ">=", etc. werden Leerzeichen gesetzt. Nach den Klammern (), {} und [] werden Leerzeichen vermieden. Allerdings müssen bei if-Klauseln und anderen Schlaufen (z.B. for, foreach, while etc.) Leerzeichen nach den Klammern () gesetzt werden.

Strings
Bei Strings werden die einfachen Anführungs- und Schlusszeichen ' ' verwendet, da so keine Probleme mit allfälligen HTML-Tags entstehen können und ausserdem wird der PHP-Code im String so nicht ausgeführt. Bei Datenbankabfragen werden doppelte Anführungszeichen " " geschrieben. Um Strings miteinander zu verbinden oder Variablen zu integrieren wird ein Punkt geschrieben. Vor und nach dem Punkt ist ein Leerschlag zu setzen.

Beispiel
while ( $_GET['show'] == 'sites' ) {
    if ( $var <= 10 ) {
        $output .= 'Dies: ' . $var;
    }

Kommentar schreiben

Kommentare: 0