Java Code Conventions

Für Java-Programme sollte man sich an den Java-Code-Konventionen orientieren:

  • Jede Java-Klasse sollte dabei in einer separaten Datei gespeichert werden, mit einem einführenden Kommentar beginnen und nicht mehr als 2000 Zeilen Code enthalten.
  • Die Klasse selbst sollte folgendermaßen strukturiert sein:
    • Statische (Klassen-)variablen
    • Instanzvariablen
    • Konstruktoren
    • Methoden
  • Eine einer Zeile sollte stets nur eine Deklaration oder Anweisung stehen.
  • Blöcke sollten stets geklammert werden, auch wenn sie nur aus einer Anweisung bestehen.
  • Binäre Operatoren sollten stets durch Leerzeichen von ihren Operanden getrennt werden, unäre hingegen nie:
(1 + 2) * (3 - 4)
i++

  • Klassen- und Interface-Bezeichner sollten möglichst Hauptworte sein und mit einem Großbuchstaben beginnen.
    jedes Teilwort eines zusammengesetzten Begriffes sollte mit einem Großbuchstaben beginnen: TrivialClassNameAsSample.
    Abkürzungen sollten vermieden werden, solange sie nicht gebräuchlicher sind als der ursprüngliche Begriff (URL, HTML)
  • Instanzvariablen beginnen mit einem Kleinbuchstaben, bei zusammengesetzten Begriffen beginnt jedes weitere Teilwort mit einem Großbuchstaben.
  • Selbiges gilt für Methoden; für diese sollten zudem möglichst Verben verwendet werden.
  • Klassenkonstanten (z. B.
static final String BLACK = "#000000"
) werden ausschließlich in Großbuchstaben geschrieben.

-- ChristopherHuhn - 12 Nov 2003
Topic revision: r4 - 2003-11-14, christo
 
This site is powered by FoswikiCopyright © by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding GSI Wiki? Send feedback
Imprint (in German)
Privacy Policy (in German)