Coding Guidelines

Die nachstehenden Coding-Guidelines sind nicht nur an direkte Kajona-Entwickler gerichtet, sondern auch an "externe" Entwickler. Eine gemeinsame Basis beim Codieren der Sourcen ermöglicht es später, fremden Programmcode schnell in das Projekt einzugliedern. Und davon haben dann ja vermutlich beide Seiten etwas ;)

Allgemeines

  • Sämtlicher Quellcode wird in Englisch verfasst
  • Logische Programmabschnitte können durch Kommentar-Linien getrennt werden (//--------). Diese sollten nicht länger als 106 Zeichen sein
  • Tabs werden nicht verwendet, sie werden duch 4 Leerzeichen repräsentiert

Variablen

  • Benennung der Variablen
    Da PHP eine typlose Script-Sprache ist, ist es zwingend erforderlich im Namen einer Variable den Datentyp der Variable ersichtlich zu machen. Deshalb erhalten Variablen in Kajona ein Präfix aus drei bis fünf Buchstaben:
    • String: str
    • Integer: int
    • Float: float
    • Bool: bit
    • Array: arr
    • Objekte: obj

    Des Weiteren gilt auch in Kajona, das Variablen mit sprechenden Namen gekennzeichnet werden sollen. Leerzeichen in Form von Unterstrichen sind hierbei nicht gestattet.
    Gültige Variablenamen wären also:
    • $bitFileChecked
    • $strPagecontent
    • $objDownloadfile

  • Initialisierung der Variablen
    Variablen müssen in Kajona immer initialisiert werden, bevor diese verwendet werden. Nicht erlaubt wäre also:
    $strText .= "Hallo Welt".$strAndereVariable;
    Korrekt wäre:
    $strText = "Hallo Welt".$strAndereVariable;
    oder
    $strText = "";
    $strText .= "Hallo Welt".$strAndereVariable;

Klassen, Interfaces

Klassen und Interfaces werden immer mit einem Präfix
class_
oder
interface_
benannt. Bei Klassen folgt danach die Zuordnung zu einem Modul und dann die Funktionalität. Aussehen könnte so etwas wie folgt:
class_modul_guestbook_admin
oder
class_modul_guestbook_post.
Jede Klasse / jedes Interface muss in einer identisch benannten Datei abgelegt werden (wie in Java), mehrere Klassen in einer Datei sind nicht erlaubt.

Kommentare, Inlinedokumentation

Für beschreibende Kommentare werden immer zwei Schrägstriche als Einleitung verwendet. Auch um Code auszukommentieren werden zweifache Schrägstriche verwendet. Das Raute-Zeichen (#) ist hierfür nicht erlaubt. Längere Codeblöcke oder Kommentare werden durch Block-Kommentare kommentiert.

//Ein Kommentar im Quellcode
// if($bitChecked === false)

/*
* Hier sollte ein längerer Kommentar folgen.
* Der einiges erläutert.
*/
/*
while(true)
echo "Ich bin eine Endlosschleife"
*/

Generell gilt, dass sämtliche erstellten Klassen, Interfaces, Methoden und Funktionen durch entsprechende PHPDoc-Kommentare dokumentiert werden sollten.
Kommentar schreiben