Coding Guidelines

Aus AntamarWiki
Wechseln zu: Navigation, Suche

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)

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
Notepad pp utf8 ohne bom.jpg



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


Tabs: Einstellungen -> Optionen... -> Sprachmenü/Tabs
Notepad pp tabs.jpg



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.
Notepad pp tabs zurueck.jpg