Kommentieren in Java

Kommentare sind Teil des Quelltextes, wobei sie keinen Einfluss auf die Funktionalität des Programms haben. Sie werden zur Erläuterung des Programmcodes verwendet.

Erklärung

Kommentare werden in Java verwendet, um den Programmcode zu erklären. Dabei werden diese bei der Ausführung des Programmes ignoriert.

Schau dir als Beispiel folgenden Code an:

Was genau der Code macht, ist zwar recht schnell ersichtlich (er berechnet die Quadratzahl der number), jedoch kann es vor allem bei langem und komplexem Code schnell unübersichtlich werden.

Es gehört zum guten Stil, Kommentare zu verwenden, denn dadurch können andere besser nachvollziehen, was du programmiert hast und du weißt auch noch Jahre später, was der Code eigentlich macht.

Schau dir denselben Code mit Kommentaren an:

Jetzt kann gut nachvollzogen werden, was dieser Code eigentlich macht.

Wie du in dem Code-Beispiel gesehen hast, gibt es mehrere Arten von Kommentaren:

• Einzeiliger Kommentar
• Mehrzeiliger Kommentar
• Dokumentationskommentar

Einzeiliger Kommentar

Der einzeilige Kommentar wird verwendet, wenn der Kommentar in eine Zeile passt, er also recht kurz ist. Am Ende der Zeile wird der Kommentar automatisch beendet. Er geht also nicht in der nächsten Zeile weiter.

Er wird mit zwei Schrägstrichen begonnen:

Mehrzeiliger Kommentar

Ein mehrzeiliger Kommentar bietet sich an, wenn du mehrere Zeilen für deinen Kommentar benötigst.

Er beginnt mit einem Schrägstrich und einem Stern über der ersten Kommentarzeile und endet mit einem Stern und einem Schrägstrich unter der letzten Kommentarzeile:

Dokumentationskommentar

Dokumentationskommentare werden vor Klassen oder Methoden geschrieben, um diese zu beschreiben und um Meta-Daten anzugeben.

Die Meta-Daten erkennst du an dem vorangestellten @-Zeichen. Dazu zählen zum Beispiel Angaben zum Autor oder welche Parameter verwendet wurden.

Aus den Dokumentationskommentaren kann ein Java-Doc erstellt werden. In diesem Dokument kannst du dann sehen, welche Klassen und Methoden verwendet wurden, wer das Programm geschrieben hat, welche Parameter verwendet wurden und so weiter.

Die Dokumentationskommentare beginnen mit einem Schrägstrich und zwei Sternen über der ersten Kommentarzeile und enden mit einem Stern und einem Schrägstrich unter der letzten Kommentarzeile:

Beispiel

Jans, Nicoles und Jeremiahs Campingausflug neigt sich dem Ende zu. Es hat ihnen richtig Spaß gemacht, aber sie sind auch froh, wenn sie wieder in einem richtigen Bett schlafen können. Sie fangen an, alles einzupacken. Als sie jedoch fertig sind, stellen sie fest, dass sie keinen Plan mehr haben, wo sie ihr Auto geparkt haben. Sie haben sich nur Folgendes aufgeschrieben:

Sie wissen jedoch nicht mehr, was genau die Variablen zu sagen haben.

Mühsam versuchen sie sich zu erinnern und ergänzen den Code um folgende Kommentare:

Dank ihrer Kommentare finden sie schließlich den Weg zu ihrem Auto. Damit sie nächstes Mal nicht wieder so planlos sind, nehmen sich die Drei vor, ab jetzt mehr auf Kommentare zu achten. Ob das wirklich was wird?