Java-Regeln

 http://java.sun.com/docs/codeconv/

Formatierungen
R1. Zeilen dürfen nicht länger als 72 Zeichen sein.
R2.

Zeilenumbrüche werden nach Komma und vor Operatoren vorgenommen.
R3.

Nach Zeilenumbrüchen doppelt weit einrücken.
R4.

Zusammengehörige logische Einheiten werden durch Leerzeichen getrennt.
R5.

Vor und nach Operanden ( +, -, *, /, &&, ...) erscheint jeweils ein Leerzeichen.
R6.

Hinter '(' und vor ')' erscheint kein Leerzeichen.

 

Kommentare

 http://java.sun.com/products/jdk/javadoc/writingdoccomments.html
R7.

Vor jeder Klassendefinition steht ein Kommentar mit den Mindestangaben Zweck, Version (@version) und Autor (@author).
R8.

Kommentare nicht schachteln.
R9.

Kommentar muss mit kommentiertem Programm übereinstimmen.
R10.

Kommentare sollten in Englisch sein. (Empfehlung)
R11.

Jeder Methode wird ein Kommentar vorangestellt mit Angaben zum Zweck und einer Erklärung der Parameter - @param. Bei Winzlingsprogrammen mit vorgegebener Struktur reicht bei selbsterklärenden Methodenbezeichnern die Kommentierung einer Demo-Methode.
R12.

Jede Variablendeklaration wird kommentiert.

 

Deklarationen und Anweisungen
R13.

In eine Zeile kommt genau eine Variablendeklaration.
R14.

Deklarationen erscheinen nur am Blockanfang.
R15.

Jede Zeile enthält maximal eine Anweisung.
R16.

Blockklammern sind immer zu verwenden, auch wenn der Block nur eine oder keine Anweisung enthält.
R17.

Leere Schleifenkörper deutlich kennzeichnen. (vgl. vorherige Regel)
R18.

Abhängige Statements innerhalb von Kontrollstrukturen, Klassen-, Methodendefinitionen ... einrücken.
R19.

Einrückung muss in Datei einheitlich sein: entweder
- geschweifte Klammer in eigener Zeile und nicht eingerückt, d.h. im Format "exdented braces" oder
- öffnende geschweifte Klammer schließt voran gehenden Text ab, d.h. im "Kernighan-Ritchie-Stil"

 

Namenskonventionen
R20.

Klassennamen sind Substantive und werden groß geschrieben.
R21.

Methodennamen beginnen mit einem Verb.
R22.

Innere Worte in Bezeichnern beginnen mit Großbuchstaben.

 

Sonstiges
R23.

Kombi-Operatoren "+=" und "-=" verwenden.