Kommentare 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.
// für einzeilige Kommentare
Beispiel:
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)
Beispiel:
/* Dies ist ein Kommentar
das auch noch
das auch
und das ist das letzte
*/
/** für JavaDoc Kommentare ( /** = Kommentar Anfang, */ = Kommentar Ende)
/** Hier Beginnt das Kommentar
* und
* geht
* hier weiter
* bis es hier endet!
*
* @author max muster
* @datum 2008-08-08
* @version 1.0
*/
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 dann liest, sollte er auch verstehen können, was das Programm macht.
Die Zeilenbefehle, die mit einem @ beginnen zeigen uns bestimmte, vordefinierte Informationen zum Programm.
