Programming Style Guide
Die hier definierten Regeln sind strikt einzuhalten. Abweichungen
führen zu Punktabzug.
- Dateinamen werden komplett klein geschrieben
und enthalten keine Umlaute und keine Sonderzeichen außer dem
Unterstrich ( _ ). Das gilt auch für die
Dateien auf der abzugebenden CD!
- Zeilen in PHP-Programmen sind höchstens 80 Zeichen
lang.
- Variablen- und Funktionsnamen beginnen (ggf. nach dem
$) mit einem Kleinbuchstaben. Sie sind grundsätzlich klein geschrieben. Ein
Großbuchstabe leitet ggf. ein neues Wort ein ("Camel Case"). Der
Unterstrich ist nicht erlaubt.
- Eine öffnende geschweifte
Klammer { steht am Ende einer Zeile. Die folgenden
Zeilen werden um einen immer gleichen Betrag eingerückt (wahlweise 2, 3
oder 4 Zeichen). Die schließende Klammer } steht
in einer eigenen Zeile wieder an der Ursprungseinrückung.
- Alle Namen in Datenbanken bestehen nur aus Buchstaben
und Ziffern, ohne Sonderzeichen und Umlaute. Für die Klein-/Großschreibung
gilt:
- Namen von Datenbanken sind komplett klein.
- Namen von Tabellen beginnen groß, danach Camel Case.
- Namen von Attributen beginnen klein, danach Camel Case.
- Include-Dateien enthalten ausschließlich
Funktionen.
- Die Definition einer eigenen Funktion beginnt mit einem
Kommentar, der folgende Punkte enthält:
- kurze Beschreibung der Aufgabe (1 - 2 Zeilen),
- Erklärung aller Parameter,
- Erklärung aller Rückgabewerte.