Java-Kom­men­ta­re: So behältst du im Code den Überblick

Es gibt drei Varianten von Java Comments, mit denen du deinen Code struk­tu­rie­ren und ver­ständ­lich auf­be­rei­ten kannst. Während ein­zei­li­ge Kom­men­ta­re für kurze Notizen gedacht sind, bieten Block­kom­men­ta­re Platz für aus­führ­li­che Er­klä­run­gen. Do­ku­men­ta­ti­ons­kom­men­ta­re sind hingegen besonders de­tail­liert und schaffen auch außerhalb des Quell­codes einen echten Mehrwert.

Was sind Java Comments und warum brauchst du sie?

Die Arbeit im Quellcode kann selbst Profis vor Her­aus­for­de­run­gen stellen. Je nach Pro­jekt­um­fang entstehen Un­klar­hei­ten und der Code verliert an Übersicht. Das ist schon mühsam, wenn du alleine pro­gram­mierst. Sobald aber andere Personen auf deinen Code zugreifen, ist Ver­wir­rung vor­pro­gram­miert. Java Comments sind in der Pro­gram­mier­spra­che ein wichtiges Tool, um Miss­ver­ständ­nis­se zu vermeiden und den Code sauber zu struk­tu­rie­ren. Die Kom­men­ta­re dienen zur Be­schrei­bung von Ge­dan­ken­gän­gen, Be­rech­nun­gen, Methoden, Klassen oder Struk­tu­ren. Wenn du selbst oder dein Team später in den Code schaut, er­leich­tern die Kom­men­ta­re die Arbeit enorm.

Damit diese Kom­men­ta­re effektiv sind, solltest du dich kurz fassen, aber alle re­le­van­ten In­for­ma­tio­nen hin­ter­le­gen. Besonders bei der Feh­ler­su­che sind präzise Kom­men­ta­re Gold wert. Es gibt sie in drei Versionen: Ein­zei­li­ge Kom­men­ta­re (single-line comments), Block­kom­men­ta­re (multi-line comments) und Do­ku­men­ta­ti­ons­kom­men­ta­re (do­cu­men­ta­ti­on comments). Sie werden speziell markiert und daher beim Kom­pi­lie­ren ignoriert. Wir zeigen dir hier, wie du die ver­schie­de­nen Java Comments einsetzt und wann welcher Typ am sinn­volls­ten ist.

Welche Kom­men­ta­re stehen zur Auswahl?

Je nach Art der In­for­ma­ti­on, die du im Quellcode un­ter­brin­gen willst, eignen sich un­ter­schied­li­che Formate. Du hast die Wahl zwischen diesen drei Typen:

Single-line Comment

Das ist die ein­fachs­te Option. Sie wird durch zwei Schräg­stri­che ein­ge­lei­tet und umfasst genau eine Zeile. Ein End­zei­chen ist nicht nötig, da der Kommentar am Zei­len­en­de au­to­ma­tisch stoppt. Diese Java Comments sind ideal für kurze Hinweise, die eine Funktion mit wenigen Worten erklären.

Multi-line Comment

Wenn Er­klä­run­gen länger ausfallen, nutzt du mehr­zei­li­ge Kom­men­ta­re. Sie können beliebig lang sein und eignen sich für de­tail­lier­te Aus­füh­run­gen oder um Code­zei­len testweise von der Kom­pi­lie­rung aus­zu­schlie­ßen. Diese Block­kom­men­ta­re starten mit einem Schräg­strich und einem Sternchen. Um den Kommentar zu beenden, setzt du ein Sternchen gefolgt von einem Schräg­strich. Alles da­zwi­schen wird als Kommentar behandelt.

Do­cu­men­ta­ti­on Comments

Während andere Kom­men­ta­re überall stehen können, befinden sich Do­ku­men­ta­ti­ons­kom­men­ta­re immer direkt vor den Klassen oder Methoden, die sie be­schrei­ben. Mit spe­zi­el­len Tools werden diese Kom­men­ta­re aus­ge­le­sen und in einer HTML-Do­ku­men­ta­ti­on auf­be­rei­tet. Sie dienen vor allem dazu, Metadaten zu Autor:innen sowie spe­zi­fi­sche Parameter zu de­fi­nie­ren. Diese werden mit einem @-Symbol markiert. Do­ku­men­ta­ti­ons­kom­men­ta­re starten mit einem Schräg­strich und zwei Sternchen und enden mit einem Sternchen sowie einem Schräg­strich.

Single-line Comments

Um die Java Comments in der Praxis zu verstehen, helfen einfache Beispiele. Du kannst diese direkt aus­pro­bie­ren. Ein ein­zei­li­ger Kommentar steht entweder in einer eigenen Zeile oder hinter einer Anweisung. Er wird durch zwei Schräg­stri­che markiert. So sieht das in einer eigenen Zeile aus:

// Beispiel für einen Single-line Comment
class Main {
	public static void main(String[] args) {
	// Hier steht der Kommentar
	System.out.println("Dies ist der Text, der am Ende ausgegeben wird.");
	}
}

Wenn du den Java-Befehl System.out.println ausführst, erscheint nur der Satz „Dies ist der Text, der am Ende aus­ge­ge­ben wird.“. Die Kom­men­ta­re bleiben rein im Quelltext sichtbar.

Al­ter­na­tiv plat­zierst du den Kommentar direkt hinter der Anweisung:

// Beispiel für einen Single-line Comment
class Main {
public static void main(String[] args) {
System.out.println("Dies ist der Text, der am Ende ausgegeben wird."); // Hier steht der Kommentar.
	}
}

An der Ausgabe ändert das nichts.

Multi-line Comments

Für mehr­zei­li­ge Kom­men­ta­re nutzt du die Kom­bi­na­ti­on aus Schräg­strich und Sternchen. Hier siehst du ein Beispiel für einen Block­kom­men­tar vor der ei­gent­li­chen Anweisung:

/* In diesem Beispiel verwenden wir einen Multi-line Comment.
Er beginnt nach dem Multiplikationszeichen.
Die eigentliche Anweisung steht unter dem Kommentar.
Dies ist die letzte Zeile des Java Comments.
*/
class Main {
public static void main(String[] args) {
System.out.println("Dies ist der Text, der am Ende ausgegeben wird.");
	}
}

Die Ausgabe lautet weiterhin nur: „Dies ist der Text, der am Ende aus­ge­ge­ben wird.“.

Willst du den Kommentar unter die Anweisung setzen, sieht das so aus:

// Beispiel für einen mehrzeiligen Kommentar, der unter der Anweisung steht.
class Main {
public static void main(String[] args) {
System.out.println("Dies ist der Text, der am Ende ausgegeben wird.");
/* In diesem Beispiel verwenden wir einen Multi-line Comment.
Er beginnt nach dem Multiplikationszeichen.
Die eigentliche Anweisung steht über dem Kommentar.
Dies ist die letzte Zeile des Java Comments. */
	}
}

Das Ergebnis bleibt identisch. Auch der Single-line Comment in der ersten Zeile wird ignoriert. Ob du das Ende des Multi-line Comments direkt hinter den Text oder in eine neue Zeile setzt, ist dir über­las­sen.

Do­cu­men­ta­ti­on Comments

Do­ku­men­ta­ti­ons­kom­men­ta­re ähneln Block­kom­men­ta­ren, starten aber mit einem Schräg­strich und zwei Sternchen. Dadurch erkennen Tools diese Stellen und ge­ne­rie­ren daraus eine Do­ku­men­ta­ti­on. Du kannst hier sogar HTML-Tags wie <h1>, <p> oder <strong> verwenden.

Javadoc, ein gängiges Tool zum Auslesen dieser Kom­men­ta­re, nutzt zudem hilf­rei­che Tags. Hier sind die wich­tigs­ten: