Coding Guidelines

Richtlinien

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

• Einrückung: 2 Leerzeichen (keine Real-Tabs)

• Dateikodierung: UTF-8 ohne BOM

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

• Kommentare über PHP-Funktionen: phpdoc-kompatibel

• Klammersetzung: 1TBS (Java-Style), also wie folgt:
  

if(bedingung) {

 //...

} else {

 //...

}

• 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

Anleitungen für Texteditoren

Natürlich ist jedem die Wahl des Editors freigestellt. Im Folgenden wollen wir kurz die Editoren notepad++ und Kate vorstellen, insbesondere wie sich mit ihnen die o.g. Richtlinien einstellen lassen.

notepad++

(die Bilder basieren auf der Version 5.5 des Editors):


Zeichenkodierung: Einstellungen -> Optionen... -> Neu/Öffnen/Speichern




Die Zeichenkodierung der aktuellen Datei kann unten rechts eingesehen werden. "ANSI as UTF-8" steht für "UTF-8 ohne BOM".

Tabs: Einstellungen -> Optionen... -> Sprachmenü/Tabs




Zeilenumbruch: Mit dem Häkchen bei Ansicht -> Zeilenumbruch entsteht kein horizontaler Scrollbalken, wenn der Code mal zu lang wird (z.B. bei Textausgaben). Äußerst nützlich!


Einrückungen zurück nehmen (Text nach links verschieben): Es kommt öfter vor, dass der Text zu weit eingerückt wurde. Um ihn wieder nach links zu rücken, kann dies mit SHIFT+TAB geschehen.