Die Coderegeln
Regel 1: Achten Sie auf Struktur und Übersichtlichkeit – Der weltweit wichtigste und weitverbreitetste Standard ist das Einrücken von Code. Hier sollte sich das Team oder der Entwickler auf einen Standard festlegen.
Regel 2: Halten Sie alles so einfach wie möglich – Wenn man eine lange und komplizierte Funktion durch eine Klasse mit vier oder fünf übersichtlichen Methoden ersetzen kann, so ist der Aufwand fast immer gerechtfertigt.
Regel 3: Jede PHP-Datei sollte das Copyright, den Dateinamen und einen Kommentar enthalten, welcher die Funktionalität beschreibt – Das Copyright sollte zur Wahrung der eigenen Rechte oder der gewählten Lizenz in jeder PHP-Datei erwähnt werden.
Regel 4: Jede Datei wird mit Änderungskommentaren und einem Zeitstempel versehen – Wenn kein SVN oder CVS zur Verfügung steht, sollte das Team eine Konvention vereinbaren, wie Änderungen am Quellcode dokumentiert werden. Zum Beispiel könnte man die Initialen jedes Teammitglieds verwenden und das Datum. Ob die Kommentare im Kopf der Datei gemacht werden oder an der betroffenen Stelle, sollte das Team vor dem Projekt entscheiden und dann einheitlich für sämtliche Dateien umsetzen.
Regel 5: Die Sprache für Kommentare und Bezeichner sollte Englisch sein – Bezeichner von Variablen, Funktionen, Klassen und so weiter sollten in Englisch definiert werden. Sämtliche Kommentare und Dokumentation sollten ebenfalls in Englisch erfolgen. Es ist absolut notwendig und unumgänglich, Quellcode zu dokumentieren. Absolut unzulässig ist eine Mischung aus Englisch und Deutsch.
Regel 6: Externe Dateien sollten mit „*.inc.php“ enden und in einem Unterverzeichnis liegen – Es ist besser, ein Unterverzeichnis „include“ oder „inc“ für die externen Dateien anzulegen, die per include() oder require() eingelesen werden. Es muss die Dateiendung „*.inc.php“ verwendet werden. Die Dateiendung „*.inc“ reicht leider nicht aus, da sie standardmäßig nicht vom PHP-Parser erfasst wird und sämtliche Informationen der Datei unter anderem auch sensible Daten, wie Passwörter, im Klartext erscheinen würden.
