Kommentare
In Java gibt es verschiedenen Möglichkeiten, Kommentare im Programmcode unterzubringen.
Hier einige Beispiele.
Inline Kommentare in Java
Die einfachsten Kommentarse beginnen mit zwei Slashes ("//"); diese Kommentare gehen automatisch bis zum Zeilenende, also bis zum nächsten Zeilenumbruch.
Hir ein Beispiel mit einem solchen Inline-Kommentare in Java:
public void doSomething() { // diese Methode tut irgendwas, das hier beschrieben werden kann
for (int i = 300; i < 1000; i++) { // hier kann z. B. erklärt werden, warum i von 300 bis unter 1000 laufen soll
// und so weiter, und so fort
}
}
for (int i = 300; i < 1000; i++) { // hier kann z. B. erklärt werden, warum i von 300 bis unter 1000 laufen soll
// und so weiter, und so fort
}
}
Mehrzeilige Kommentare in Java
Will man mehrzeilige Kommentare schreiben, so wäre es lästig, jede Zeile mit// beginnen zu müssen.
Das muss man auch nicht, weil es für mehrzeilige Kommentare in Java eine eigene Syntax gibt.
Starten man einen Kommentare mit Slash und Stern ("
/*), so endet dieser erst an der Position, wo ein Stern und Slash steht ("*/") - auch dann, wenn diese Zeichenkombination erst viele Zeilen später kommt.
Am einfachsten sieht man das wieder an einem Beispiel:
/* Mehrzeilige Beschreibung der Methode.
Alles, was hier steht, dient nur der Kommentierung des Programmcodes.
Autor: XY. */
public void doSomething() {
/*
Hier folgt eine ggf mehrzeilige Erlärung, warum die Schleifenvariable i
ausgerechnet von 300 bis unter 1000 laufen soll.
*/
for (int i = 300; i < 1000; i++) {
/* und so weiter, und so fort, wie man hier sieht, kann der auch einzeilig bleiben. */
/* Hauptsache, am Ende wird er korrekt "geschlossen". */
}
}
Alles, was hier steht, dient nur der Kommentierung des Programmcodes.
Autor: XY. */
public void doSomething() {
/*
Hier folgt eine ggf mehrzeilige Erlärung, warum die Schleifenvariable i
ausgerechnet von 300 bis unter 1000 laufen soll.
*/
for (int i = 300; i < 1000; i++) {
/* und so weiter, und so fort, wie man hier sieht, kann der auch einzeilig bleiben. */
/* Hauptsache, am Ende wird er korrekt "geschlossen". */
}
}
Javadoc Kommentare in Java
Javadoc ist eine Formatkonvention für Kommentare in Java, mit der man ganze Klassen, Methoden und/oder Attribute beschreiben kann.Wenn man sich an die vorgegebene Konvention hält, so kann diese Dokumentation mit fertigen Tools extrahiert werden.
Dies kann zum Beispiel das Original Javadoc Tool sein, welches HTML-Seiten mit den Kommentaren erzeugt, oder aber auch eine moderne Entwicklungsumgebung, welche den Javadoc-Kommentar als Hilfetext einer Klasse, eines Attributs oder einer Methode anzeigen kann.
Die Formatkonvention ist denkbar einfach:
Javadoc ist im wesentlichen identisch mit der Syntax für mehrzeilige Kommentare, mit dem Unterschied, dass der Start des Kommentars zwei statt nur einem Stern enthält.
Hier ein Beispiel mit einem Kommentar in der Javadoc Syntax:
/**
* Dies ist ein Javadoc-Kommentar. Moderne IDEs können diesen Kommentartext extrahieren
* und als Hilfetext zur angegebenen Methode anzeigen.
* Das Tool javadoc kann eine HTML-Dokumentation von Klassen oder ganzen Paketen erzeugen
* und beschreibt diese Methode mit eben diesem Text hier.
*/
public void doSomething() {
for (int i = 300; i < 1000; i++) {
// und so weiter, und so fort
}
}
* Dies ist ein Javadoc-Kommentar. Moderne IDEs können diesen Kommentartext extrahieren
* und als Hilfetext zur angegebenen Methode anzeigen.
* Das Tool javadoc kann eine HTML-Dokumentation von Klassen oder ganzen Paketen erzeugen
* und beschreibt diese Methode mit eben diesem Text hier.
*/
public void doSomething() {
for (int i = 300; i < 1000; i++) {
// und so weiter, und so fort
}
}
Ein Detail am Rande: die führenden Sternchen in den einzelnen Kommentarzeilen erhöhen die Lesbarkeit im Programmcode (auch wenn das vielleicht Geschmacksache ist).
Keine Geschmacksache, sondern spezifiert, ist die Tatsache, das solche Sternchen beim Auswerten von Javadoc-Kommentaren ignoriert werden.
Die Hilfe in einer IDE, oder das HTML-Dokument von Javadoc wird also nicht durch diese Sternchen verunreinigt.
| Nach oben, Inhaltsverzeichnis, Impressum |
Admin: Artikel editieren |