Kommentare in Java

... sind kurze Beschreibungen unseres Quelltextes, welche für uns oder auch andere Programmierer Hinweise geben, was das Programm hier macht usw.

Insbesondere bei längeren Quellcodes wird man sich später nicht mehr so genau daran erinnern können, was es nun mit der einen oder anderen Programmzeile auf sich hat.

Hierfür gibt es Kommentare!

Kommentare werden vom Compiler nicht berücksichtigt!

Sobald der Compiler auf eine Programmzeile trifft werden diese Kommentare übersprungen.

 

Kommentare beginnen mit:

  • // für einzeilige Kommentare
a = (b+c) / 2;  // Berechnet den Mittelwert von b und c

oder

// Kommentar Zeile 1

// Kommentar Zeile 2

// Kommentar Zeile n 

 

  •  /* für mehrzeilige Kommentare ( /* = Kommentar Anfang, */ = Kommentar Ende)
/* Hier steht ein Kommentar
hier auch
hier ebenfalls
und hier nochmals */

 

  • /** für JavaDoc Kommentare ( /** = Kommentar Anfang, */ = Kommentar Ende)
/** Hier beginnen unsere Kommentare
* @author Patrick Gaicher
* @datum 2014-07-16
* @version 1.0
und hier enden sie wieder */

 

JavaDoc ist ein sehr hilfreiches Zusatzprogramm und jedem JDK (Java Development Kit) kostenlos beigefügt.

Mit JavaDoc lassen sich nach erfolgter Programmierung automatisch vollständige Dokumentationen erzeugen. An dieser Stelle wollen wir aber nicht näher darauf eingehen.

Es hat sich eingebürgert am Anfang jeder Zeile einen * zu machen, um die Kommentare übersichtlicher darzustellen.

Die ersten Zeilen enthalten eine allgemeine Beschreibung des Programms.

Diese Beschreibung soll aber Sinn machen, da JavaDoc aus diesen Kommentaren später eigenständige Dateien erzeugt.

Wenn jemand diese Dokumente liest, sollte er auch verstehen können, was das Programm macht.

Die Befehlszeilen, die mit einem @ beginnen zeigen uns bestimmte, vordefinierte Informationen zum Programm.