Workshop - Java Code Style

1 Allgemeine Java Programmierrichtlinien

Folgenden Konventionen sind von SUN herausgegeben und sollten nahezu gänzlich angewandt werden. Der Vorteil liegt auf der Hand. Der Code ist: leicht zu warten, leicht durch jeden zu lesen und Fehler werden schneller identifiziert

1.1 Java-Namenskonventionen

Bezeichner
  • Aussagekräftige Namen! wie Akkumulator, AkkuLadeGeraet
  • Bei einer Sprache im Quelltext bleiben!
  • Nutze nur folgende Zeichen: A-Z, a-z, 0-9 und der Unterstrich _ für Bezeichner
  • Schreibe im "Upper Case Camel Style"! AkkuLadeGeraet, LadeVorgang
Variablen, Attribute und Parameter
  • Variablen beginnen mit einem Kleinbuchstaben und weitere Teilwörter mit einem Großbuchstaben akku, akkuLadeGeraet
  • Konstanten in Großbuchstaben und Teilwörter werden durch den Unterstrich voneinander getrennt. AKKU_LADUNG, LADUNG
  • Verwendet minimum ein Substantiv für Variablen
  • Nimm i,j,k,l für Zählvariablen
  • Stelle das Schlüsselwort this IMMER Objektattributen voran this.akkuLadung
Methoden
  • Nutze mindestens ein Verb im Namen der Methode akkuAufladen(), entladen()
  • Verwende getter und setter zum Zugriff auf Objektattribute String getLadestand(), void setLadestand
static
  • Referenziere Klassenvariablen immer mit Klassennamen Math.abs(-19), Color.blue
Packages
  • nur Kleinbuchstaben für Paketnamen
  • nie für Paketnamen java oder javax verwenden!!!

1.2 Quelltextformatierung

Allgemein
  • nie verschiedene Programmierstile in Klassen mischen!
  • nicht mehr als 80 Zeichen in eine Zeile
Anweisungen
  • bei Kontrollanweisungen immer geschweifte Klammern nutzen und Anweisungem darin einrücken
  • folgt auf ein if direkt ein else darf das Klammernpaar weg gelassen werden
  • die öffnende Klammer kommt entweder direkt nach einer Kontrollanweisung oder in die nächste Zeile
  • eine Anweisung pro Zeile!
  • vermeide continue und break
  • Verschachtelungen mit mehr als einer Tiefe von 3 vermeiden
Ausdrücke
  • vor und nach jedem Operater ein Leerzeichen
  • überlange Ausdrücke an der schwächsten Bindung umbrechen
  • boolesche Wert nie mit == vergleichen
    Richtig Falsch
    akkuLaden akkuLaden == true
    akkuEntladen == false !akkuEntladen
  • Wähle für einen Ausdruck die selbe Operatorenreihenfolge wie in einem mathematischen Ausdruck, implementiere 0 < i < j < n als 0 < i && i < j && j < n
Methoden
  • kurze Methoden mit nicht mehr als 25 Zeilen!
  • deklariere alle Variablen am Anfang der Methode außer Schleifenvariablen