 |
- Hauptklasse (public class) zu erst
- Die Ordnung:
1- Beginning comments
2- Package and Import statements
3- Class and Interface statements
1- Beginning comments:
Sollen wir folgt aus sehen:
/** (ganz wichtig: ZWEI Stenrne!
* $ Id:$
*Weitere Erklärungen
*/
2- Package and Import statements
Erst Package, dann import
3-Class and Interface statements
Class/Interface documentation comment(/** */)
Class/Interface statement
Class/Interface implementation comment
Class (static) variables
Interface variables
Instance variables
Constructors
Methods
Beispiele und mehr Infos:
Java Conde Conventions
Einrücken
4 oder 8(ein tab) Leerzeichen, 4 wird bevorzügt.
Zeilen
Keine Zeilen länger als 80 Zeichen, Zeile brechen nach folgenden Anweisungen:
Nach dem Komma
Vor dem Operator
Wenn möglich nicht innerhalb eines Klammerns
Neue Zeile einrücken
Beispiele und mehr Infos:
Java Conde Conventions
Kommentare
Zwei Arten von Kommentaren:
1- Blockkommentar:
/*
*hier kommt das Kommentar
*/
Ein Blockkommentar soll immer mit $ id:$ beginnen:
/** (ganz wichtig: ZWEI Stenrne!
* $ Id:$
*/
2- EndOfLine Kommentar: //
Beispiele und mehr Infos:
Java Conde Conventions
Dokumentationskommentare:
Blockkommentare vor jeder Klasse oder Methode, enthält Informationen zur der Klasse/Methode
Deklaration:
Eine Deklaration pro Zeile,
Nicht zwei Typen in einer Zeile deklarieren
Beispiele und mehr Infos:
Java Conde Conventions
Initialisierung:
Lokale Variablen immer beim Deklarieren initialisieren
Ausnahmen:
For(int i = 0; i<100;i++)
Beispiele und mehr Infos:
Java Conde Conventions
Klasse und Interface Deklarationen
Regeln:
Kein Leerzeichen zwischen Methodenname und Klammer myMethode();
"{" kommt am Ende der Zeile mit der Deklaration
"}" kommt am gewohnten Ort!
Zwischen den einzelnen Methoden eine Freizeile
Beispiele und mehr Infos:
Java Conde Conventions
Statement:
Jede Zeile ein Statement
Beispiel:
a++; //OK
b++; // OK
a++, b++; // zu vermeiden
Andere Statements
Bei if, if-else, while, do-while, switch, try-catch Regeln siehe Java Conde Conventions
vielleicht sollte man bei "if" sagen, dass nach if immer ein Block(also {...}) kommen muss, egal wie klein die Kondition ist
Freizeilen
Zwei Freizeilen bei:
zwischen Teile der source Datei
zwischen Class and Interface definitionen
Eine Freizeile bei:
zwischen verschiedenen Methoden
zwischen lokale Variablen und des ersten Statement
vor einem Blockkommentar, oder ein Einzeilerkommentar
zwischen logischen Teile einer Methode, um das Lesen zu erleichtern
Beispiele und mehr Infos:
Java Conde Conventions
Leerzeichen
- Nach Kommata
- Zwischen Binäre Operationen
Beispiel
a += c + d;
- Nicht bei a++, a--, und der Punktoperatiopn (a.methode)
- In der "for" klammer: for (a1; a2; a3)
- Bei Casts: (byte) aMun, (objekt) x)
Beispiele und mehr Infos:
Java Conde Conventions
Namen
Namensgebung in Deutsch!
Doch Methoden wie get() usw., bei den die Bedeutung klar ist können weiter in Englisch geschrieben werden!
Packages: Kleinbuchstaben,
Klassen: Sollten Namen sein, Mit Großbuchstaben anfangen, sonst Kleinbuchstaben, keine Abkürzung, wenn 2 Wörter: das 2. Wort auch mit Großbuchstabe anfangen
Beispiel:class ImageSprite
Interfaces: Wie Klassen
Methoden: Sollten Verbe sein,erste Buchstabe klein, sonst wie Klassen
Beispiel: Run();, runFast();
Variablen: wie Methoden, so kurz wie möglich
Nur "Wegwerf"- Variablen sollten ein Buchstabe sein. I, j, k, m für Zahlen, c, d und e für Characters
Konstanten: Großbuchstaben, getrennt durch "_"
Beispiel: Static final int MIN_WIDTH = 4;
Beispiele und mehr Infos:
Java Conde Conventions
Tipps
- Schlecht:
fchar = lchar = 'c', nicht alles in einer Zeile
- sich nicht in die Sachen des Compilers einmischen:
nicht: d = (a = b + c) + r,
sondern:
a = b + c;
d = a + r;
- lieber zuviel Klammern als zu wenig!
Nicht:
If (a == b && c == d),
sondern:
If ((a == b) && (c == d))
Beispiele und mehr Infos:
Java Conde Conventions
Programmbeispiel
Siehe
Java Conde Conventions
von Arash Sarkohi
