Java Code-Konventionen

Um die Klarheit der Syntax, deren Wartungsaufwand und ihre Lesbarkeit zu optimieren, schreibt Oracle in seinen Code Conventions Regeln zur syntaktischen Korrektheit von Java-Quelltexten vor.

Im Internet, der Literatur und selbst in Lehrtexten findet man gelegentlich Java-Quelltexte, die gemäß den Konventionen anderer Programmiersprachen (PHP, C/C++...) mit Unterstrichen, Dollarzeichen, u.ä. verfasst wurden oder in denen die Groß-/Kleinscheibung syntaktischer Strukturen nicht oder unzureichend berücksichtigt wird. Dies erschwert nicht nur die Lesbarkeit und erhöht den Wartungsaufwand eines Programms, sondern kann sogar zu Fehlern führen, die seine Kompilierbarkeit verhindern.

Der Artikel gibt eine Zusammenfassung nicht aller, aber der gängigsten Regeln.2, 3

Dateien

Quelltext-Dateien

Binärcode-Dateien

Binärcode-Dateien besitzen die Endung .class.

Zeilen

Kommentare

Java kennt die folgenden drei Kommentarformen

// Einzeiliger Kommentar der Angaben zur speziellen Implementierung macht. Der Kommentar beginnt bei den Kommentarzeichen ('//') und endet mit dem jeweiligen Zeilenumbruch.
Mehrere unmittelbar aufeinander folgende einzeilige Kommentare sollten vermieden werden, können jedoch zum Auskommentieren von Quelltextanteilen verwendet werden.
// Kommentar
							
int i = 0; // Kommentar
/*...*/ Mehrzeiliger Kommentar der Angaben zur speziellen Implementierung macht. Er kann bei entsprechender Kürze auch einzeilig sein.
/* Kommentar */
							
/*
 * Kommentar
 */
/**...*/ Javadoc-Kommentar der in einfacher HTML-Formatierung vorliegen kann. Die genaue Ausgestaltung von Dokumentationskommentaren ist gesondert geregelt und kann unter http://docs.oracle.com/javase/7/docs/technotes/tools/windows/javadoc.html gesondert nachgelesen werden.
Javadoc-Kommentare sollten nicht innerhalb von Methoden oder Konstruktoren erfolgen.
/**
 * Kommentar
 */

Deklaration und Initialisierung

Klassen-, Interface- und Methodendeklaration

Statements

Leerzeichen

Namenskonventionen

Alle Bezeichner sollten grundsätzlich beredt sein, und möglichst intuitiv den Zweck angeben, für den sie stehen. Lediglich nur kurzfristig benötigte Werte, wie bspw. Zählvariablen, können durch Kurzbezeichner repräsentiert werden.
Alle Bezeichner müssen aus alphanumerischen Zeichen des ASCII-Zeichensatzs bestehen, dürfen Untersriche enthalten, jedoch nicht mit einer Ziffer beginnen.

1) Unter CamelCase versteht man eine Schreibweise, bei der aufeinander folgende Begriffe ohne Leerzeichen an den vorangehenden angefügt werden, wobei deren erste Buchstaben jeweils groß geschrieben werden. Bsp.: DampfSchiffFahrt. Die Schreibweise des allerersten Buchstabens richtet sich nach den Code-Konventionen (Klassen - groß, Variablen - klein, etc.).
2) Quelle: http://www.oracle.com/technetwork/java/index-135089.html
3) Die hier dargestellten Code-Konventionen werden auch auf javabeginners.de weitgehend eingehalten, an einigen Stellen jedoch bewusst durchbrochen, um eine für Anfänger hilfreiche Kürze und Klarheit des Quelltextes zu sichern. Insbesondere auf Kommentare wird weitgehend verzichtet, da die Quelltexte und Beispiele in der Regel durch zusätzliche Texte erläutert werden.