02.01 Kommentare

Um Ihren Code leichter lesbar zu halten und sauber zu dokumentieren, sollten Sie an wichtigen Stellen Kommentare einfügen (zum Beispiel um einzelne Schritte eines komplexen Algorithmus zu erläutern). Dabei unterscheidet man drei unterschiedliche Typen von Kommentaren.

Zeilenkommentare

Sie kommentieren eine Codezeile und beginnen mit zwei normalen Slashes. Alles, was danach bis zum Ende der Zeile geschrieben wurde, wird ignoriert.

// Ich bin ein Kommentar
public class HelloWorld {  // Kopf der Klasse

Blockkommentare

Hiermit werden ganze Absätze (aus-) kommentiert. Sei es, um einen Code-Block zu Testzwecken auszukommentieren, oder einen komplexeren Text/Kommentar übersichtlich darzustellen. Sie beginnen mit einem /* und endet mit */. Im Kommentar selber darf deshalb freilich kein */ vorkommen.

/*
 * Umlaute sind in der Konsole mancher
 * Betriebssysteme nicht gerne gesehen
 */
System.out.println("Das sind deutsche Umlaute: Ä, Ö, Ü");

JavaDoc Kommentare

JavaDoc Kommentare sind besondere Blockkommentare. Alles was in ihnen steht, wird bei einer eventuell späteren Generierung einer Dokumentation als Klassen- und Methodenbeschreibung verwendet. Sie stehen in der Regel direkt über der Klasse/Methode, die sie beschreiben sollen. Dabei beginnen sie mit /** und enden mit */.

/**
 * Das ist die Startmethode eines jeden Programms.
 * Von hier aus wird alles gesteuert!
 */
public static void main(String[] args) {