Java Comments: Alles zu Kom­men­ta­ren innerhalb der Pro­gram­mier­spra­che

Es gibt drei ver­schie­de­ne Arten von Java Comments, mit denen Sie Ihren Quellcode struk­tu­rie­ren und erklären können. Während ein­zei­li­ge Kom­men­ta­re nur für kurze An­mer­kun­gen gedacht sind, eignen sich Block­kom­men­ta­re auch für längere Er­klä­run­gen. Do­ku­men­ta­ti­ons­kom­men­ta­re sind hingegen besonders um­fang­reich und sollen auch über den Quellcode hinaus einen Mehrwert bieten.

Was sind Java Comments und wofür werden Sie benötigt?

Die Arbeit im Quellcode kann selbst erfahrene Ent­wick­le­rin­nen und Ent­wick­ler mitunter vor Probleme stellen. Je nach Projekt und Umfang entstehen Un­wäg­bar­kei­ten und der Code wird schnell un­über­sicht­lich. Das ist bereits nach­tei­lig, wenn Sie alleine an einem Programm arbeiten. Sollen al­ler­dings auch andere auf Ihren Code zugreifen, kann es zu Ver­wir­run­gen kommen. Java Comments sind in der Pro­gram­mier­spra­che ein sehr nütz­li­ches Tool, um Miss­ver­ständ­nis­se zu vermeiden und den Code besser 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 Sie selbst oder eine andere Person später auf den Code blickt, er­leich­tern die Kom­men­ta­re die Arbeit.

Damit diese Kom­men­ta­re auch wirklich effektiv sind, ist es von großer Bedeutung, dass Sie sich ei­ner­seits möglichst kurz­hal­ten, an­de­rer­seits aber auch alle not­wen­di­gen In­for­ma­tio­nen hin­ter­le­gen. Gerade bei einer Feh­ler­su­che sind gut for­mu­lier­te Kom­men­ta­re ein großer Gewinn. Es gibt sie daher in drei ver­schie­de­nen 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 gesondert ge­kenn­zeich­net und daher beim Kom­pi­lie­ren nicht be­rück­sich­tigt. In den folgenden Absätzen zeigen wir Ihnen, wie Sie die drei ver­schie­de­nen Java Comments verwenden und wann welche Typen besonders emp­feh­lens­wert sind.

Welche Kom­men­ta­re gibt es?

Je nach Art des Java Comments und des Inhalts, den Sie in den Quellcode schreiben möchten, bieten sich andere Kom­men­ta­re an. Sie haben dabei die Wahl zwischen diesen drei ver­schie­de­nen Typen:

Single-line Comment

Dies ist die ein­fachs­te Kom­men­tar­op­ti­on. Sie wird durch zwei auf­ein­an­der­fol­gen­de Schräg­stri­che angezeigt und kann nur eine Zeile umfassen. Dadurch muss auch kein Endpunkt angezeigt werden, da dieser mit dem Zei­len­en­de au­to­ma­tisch erreicht wird. Diese Java Comments eignen sich für kurze Kom­men­ta­re, die lediglich in wenigen Worten eine Funktion erklären.

Multi-line Comment

Wenn Er­klä­run­gen länger ausfallen sollen oder müssen, eignen sich mehr­zei­li­ge Kom­men­ta­re. Sie können theo­re­tisch beliebig lang sein und eignen sich nicht nur für aus­führ­li­che Er­läu­te­run­gen, sondern auch für al­ter­na­ti­ve Code­zei­len, die von der Kom­pi­lie­rung aus­ge­nom­men werden. Diese Block­kom­men­ta­re werden mit einem Schräg­strich und einem Mul­ti­pli­ka­ti­ons­zei­chen ein­ge­lei­tet. Um einen solchen Kommentar ab­zu­schlie­ßen, wird zunächst ein Mul­ti­pli­ka­ti­ons­zei­chen gesetzt, dem ein Schräg­strich folgt. Der gesamte Text zwischen diesen Zeichen wird als Kommentar behandelt und darüber hinaus nicht be­rück­sich­tigt.

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

Während die anderen Kom­men­ta­re theo­re­tisch an einer be­lie­bi­gen Stelle im Quellcode eingefügt werden können, stehen die Do­ku­men­ta­ti­ons­kom­men­ta­re immer direkt vor den Klassen oder Methoden, die sie be­schrei­ben. Mit Hilfe eines ent­spre­chen­den Tools werden diese Kom­men­ta­re aus­ge­le­sen und zu einer HTML-Do­ku­men­ta­ti­on zu­sam­men­ge­fasst. Sie werden ins­be­son­de­re genutzt, um Meta-Daten zu Autoren und Au­torin­nen sowie bestimmte Parameter anzulegen. Diese werden mit einem @-Symbol ge­kenn­zeich­net. Die Do­ku­men­ta­ti­ons­kom­men­ta­re leitet man mit einem Schräg­strich und zwei Mul­ti­pli­ka­ti­ons­zei­chen ein. Ihr Abschluss wird durch ein Mul­ti­pli­ka­ti­ons­zei­chen und einen Schräg­strich ge­kenn­zeich­net.

Single-line Comments

Um zu verstehen, wie die je­wei­li­gen Java Comments in der Praxis funk­tio­nie­ren, eignen sich ein paar einfache Beispiele. Diese können Sie selbst eingeben und die jeweilige Ausgabe testen. Ein ein­zei­li­ger Kommentar kann entweder in einer eigenen Zeile oder hinter einer Anweisung stehen. Er wird durch zwei Schräg­stri­che markiert. So sieht der Comment 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 Sie nun den Java-Befehl System.out.println ausführen, wird lediglich der Satz „Dies ist der Text, der am Ende aus­ge­ge­ben wird.“ ab­ge­bil­det. Die beiden Kom­men­ta­re stehen hingegen nur im Quelltext.

Al­ter­na­tiv setzen Sie den Kommentar direkt hinter die ei­gent­li­che 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.
	}
}

Die Ausgabe wird dadurch nicht verändert.

Multi-line Comments

Wenn Sie einen mehr­zei­li­gen Kommentar einfügen möchten, können Sie diesen vor oder nach einer Anweisung be­rück­sich­ti­gen. Er wird immer mit einem Schräg­strich und einem Mul­ti­pli­ka­ti­ons­zei­chen ein­ge­lei­tet. Wir zeigen Ihnen wieder beide möglichen Beispiele. Zunächst ein mehr­zei­li­ger Kommentar vor der 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 sollte nun lediglich „Dies ist der Text, der am Ende aus­ge­ge­ben wird.“ lauten.

Wenn Sie den Kommentar unter der Anweisung einsetzen möchten, sieht das bei­spiel­haft 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. */
	}
}

Die Ausgabe sollte dem vor­he­ri­gen Beispiel ent­spre­chen. Auch der Single-line Comment aus der ersten Zeile wird nicht aus­ge­ge­ben. Ob Sie das Ende des Multi-line Comments mit einem Mul­ti­pli­ka­ti­ons­zei­chen und einem Schräg­strich direkt hinter dem Kommentar oder in einer eigenen Zeile schreiben, bleibt Ihnen über­las­sen.

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

Do­ku­men­ta­ti­ons­kom­men­ta­re funk­tio­nie­ren ähnlich wie Block­kom­men­ta­re. Sie werden lediglich durch die Kom­bi­na­ti­on von einem Schräg­strich und zwei Mul­ti­pli­ka­ti­ons­zei­chen ein­ge­lei­tet. So können passende Tools diese Kom­men­ta­re nutzen, um eine Do­ku­men­ta­ti­on zu erstellen. Sie können bei Bedarf auch HTML-Tags wie <h1>, <p> oder <strong> enthalten.

Javadoc, ein beliebtes Tool, mit dem Sie Do­ku­men­ta­ti­ons­kom­men­ta­re auslesen, nutzt außerdem weitere hilf­rei­che Tags. Dies sind einige der wich­tigs­ten: