Java Comments: Alles zu Kommentaren innerhalb der Programmiersprache

Es gibt drei verschiedene Arten von Java Comments, mit denen Sie Ihren Quellcode strukturieren und erklären können. Während einzeilige Kommentare nur für kurze Anmerkungen gedacht sind, eignen sich Blockkommentare auch für längere Erklärungen. Dokumentationskommentare sind hingegen besonders umfangreich 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 Entwicklerinnen und Entwickler mitunter vor Probleme stellen. Je nach Projekt und Umfang entstehen Unwägbarkeiten und der Code wird schnell unübersichtlich. Das ist bereits nachteilig, wenn Sie alleine an einem Programm arbeiten. Sollen allerdings auch andere auf Ihren Code zugreifen, kann es zu Verwirrungen kommen. Java Comments sind in der Programmiersprache ein sehr nützliches Tool, um Missverständnisse zu vermeiden und den Code besser zu strukturieren. Die Kommentare dienen zur Beschreibung von Gedankengängen, Berechnungen, Methoden, Klassen oder Strukturen. Wenn Sie selbst oder eine andere Person später auf den Code blickt, erleichtern die Kommentare die Arbeit.

Damit diese Kommentare auch wirklich effektiv sind, ist es von großer Bedeutung, dass Sie sich einerseits möglichst kurzhalten, andererseits aber auch alle notwendigen Informationen hinterlegen. Gerade bei einer Fehlersuche sind gut formulierte Kommentare ein großer Gewinn. Es gibt sie daher in drei verschiedenen Versionen: Einzeilige Kommentare (single-line comments), Blockkommentare (multi-line comments) und Dokumentationskommentare (documentation comments). Sie werden gesondert gekennzeichnet und daher beim Kompilieren nicht berücksichtigt. In den folgenden Absätzen zeigen wir Ihnen, wie Sie die drei verschiedenen Java Comments verwenden und wann welche Typen besonders empfehlenswert sind.

Welche Kommentare gibt es?

Je nach Art des Java Comments und des Inhalts, den Sie in den Quellcode schreiben möchten, bieten sich andere Kommentare an. Sie haben dabei die Wahl zwischen diesen drei verschiedenen Typen:

Single-line Comment

Dies ist die einfachste Kommentaroption. Sie wird durch zwei aufeinanderfolgende Schrägstriche angezeigt und kann nur eine Zeile umfassen. Dadurch muss auch kein Endpunkt angezeigt werden, da dieser mit dem Zeilenende automatisch erreicht wird. Diese Java Comments eignen sich für kurze Kommentare, die lediglich in wenigen Worten eine Funktion erklären.

Multi-line Comment

Wenn Erklärungen länger ausfallen sollen oder müssen, eignen sich mehrzeilige Kommentare. Sie können theoretisch beliebig lang sein und eignen sich nicht nur für ausführliche Erläuterungen, sondern auch für alternative Codezeilen, die von der Kompilierung ausgenommen werden. Diese Blockkommentare werden mit einem Schrägstrich und einem Multiplikationszeichen eingeleitet. Um einen solchen Kommentar abzuschließen, wird zunächst ein Multiplikationszeichen gesetzt, dem ein Schrägstrich folgt. Der gesamte Text zwischen diesen Zeichen wird als Kommentar behandelt und darüber hinaus nicht berücksichtigt.

Documentation Comments

Während die anderen Kommentare theoretisch an einer beliebigen Stelle im Quellcode eingefügt werden können, stehen die Dokumentationskommentare immer direkt vor den Klassen oder Methoden, die sie beschreiben. Mit Hilfe eines entsprechenden Tools werden diese Kommentare ausgelesen und zu einer HTML-Dokumentation zusammengefasst. Sie werden insbesondere genutzt, um Meta-Daten zu Autoren und Autorinnen sowie bestimmte Parameter anzulegen. Diese werden mit einem @-Symbol gekennzeichnet. Die Dokumentationskommentare leitet man mit einem Schrägstrich und zwei Multiplikationszeichen ein. Ihr Abschluss wird durch ein Multiplikationszeichen und einen Schrägstrich gekennzeichnet.

Single-line Comments

Um zu verstehen, wie die jeweiligen Java Comments in der Praxis funktionieren, eignen sich ein paar einfache Beispiele. Diese können Sie selbst eingeben und die jeweilige Ausgabe testen. Ein einzeiliger Kommentar kann entweder in einer eigenen Zeile oder hinter einer Anweisung stehen. Er wird durch zwei Schrägstriche 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 ausgegeben wird.“ abgebildet. Die beiden Kommentare stehen hingegen nur im Quelltext.

Alternativ setzen Sie den Kommentar direkt hinter die eigentliche 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 mehrzeiligen Kommentar einfügen möchten, können Sie diesen vor oder nach einer Anweisung berücksichtigen. Er wird immer mit einem Schrägstrich und einem Multiplikationszeichen eingeleitet. Wir zeigen Ihnen wieder beide möglichen Beispiele. Zunächst ein mehrzeiliger 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 ausgegeben wird.“ lauten.

Wenn Sie den Kommentar unter der Anweisung einsetzen möchten, sieht das beispielhaft 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 vorherigen Beispiel entsprechen. Auch der Single-line Comment aus der ersten Zeile wird nicht ausgegeben. Ob Sie das Ende des Multi-line Comments mit einem Multiplikationszeichen und einem Schrägstrich direkt hinter dem Kommentar oder in einer eigenen Zeile schreiben, bleibt Ihnen überlassen.

Documentation Comments

Dokumentationskommentare funktionieren ähnlich wie Blockkommentare. Sie werden lediglich durch die Kombination von einem Schrägstrich und zwei Multiplikationszeichen eingeleitet. So können passende Tools diese Kommentare nutzen, um eine Dokumentation zu erstellen. Sie können bei Bedarf auch HTML-Tags wie <h1>, <p> oder <strong> enthalten.

Javadoc, ein beliebtes Tool, mit dem Sie Dokumentationskommentare auslesen, nutzt außerdem weitere hilfreiche Tags. Dies sind einige der wichtigsten: