Coding Guidelines

Aus AntamarWiki
Wechseln zu: Navigation, Suche


Für alle PHP- und AOQML-Programmierer gelten folgende Richtlinien als verbindlich:


Einrückung: 2 Leerzeichen (keine Real-Tabs) [Der Editor notepad++ erlaubt die Umwandlung von Tabs in Leerzeichen während der Eingabe]


Klammersetzung: 1TBS (Java-Style), also wie folgt:
if(bedingung) {

 //...

} else {

 //...

}


Dateikodierung: UTF-8 ohne BOM


Line Endings (Zeilenumbruchformat): Unix-Style (\n)


Kommentare über PHP-Funktionen: phpdoc-kompatibel


Groß- und Kleinschreibung:
Funktionsnamen immer klein geschrieben. Keine camelCase-Schreibweise. Unterstriche verwenden.
Variablen immer klein schreiben
ID-Variablen immer nach der Form: $held_id, also immer "_id" am Schluss