wiki:CodingStyle

Version 1 (modified by julian, 11 years ago) (diff)

Seite erstellt. Erste rudimentäre Richtlinien

So sollte der Code aussehen

Es gibt viele unterschiedliche "Coding Styles", aber für das TBB2 existiert trotzdem eigene Richtlinien. Es kann durchaus sein, dass sich diese Richtlinien mit anderen bekannten überschneiden.

Klammern

Nach einem if folgt direkt die Klammer auf. Geschweifte Klammern auf kommen grundsätzlich in dieselbe Zeile, geschweifte Klammern zu in die nächste Zeile.

  • Falsch:
    if (blablabla)
    {
        blablabla;
        blablabla;
    }
    
  • Richtig:
    if(blablabla) {
        blablabla;
        blablabla;
    }
    

Bennenung:

Bei der Bennenung von Variablen, Klassen etc. werden einzelne Wörter durch Großschreibung getrennt und nicht durch Unterstriche. Dabei beginnen alle Variablen und Funktionsnamen grundsätzlich mit einem Kleinbuchstaben. Ausnahmen bilden Module: Diese beginnen wie Klassen mit einem Großbuchstaben.

  • Falsch:
    $db = Factory::singleton('DB');
    $this->modules['navbar']->...
    class testeMich {}
    class testemich {}
    $Test = 456;
    $hallowelt = ...
    $HalloWelt = ...
    function Lalala() {}
    
  • Richtig:
    $DB = Factory::singleton('DB');
    $this->modules['Navbar']->...
    class TesteMich {}
    $test = 456;
    $halloWelt = ...
    function lalala() {}