Think Java, 2. Auflage

Anhang B. Javadoc

Java-Programme haben drei Arten von Kommentaren:

End-of-Line-Kommentare

Sie beginnen mit // und enthalten in der Regel kurze Sätze, die bestimmte Codezeilen erklären.

Mehrzeilige Kommentare

Sie beginnen mit /* und enden mit */ und werden in der Regel für Urheberrechtserklärungen verwendet .

Kommentare zur Dokumentation

Sie beginnen mit /** und enden mit */ und beschreiben, was die einzelnen Klassen und Methoden tun.

End-of-line und mehrzeilige Kommentare sind in erster Linie für dich selbst gedacht. Sie helfen dir, dich an bestimmte Details deines Quellcodes zu erinnern. Dokumentationskommentare hingegen werden für andere geschrieben. Sie erklären, wie du deine Klassen und Methoden in anderen Programmen verwenden kannst.

Eine schöne Eigenschaft der Sprache Java ist die Möglichkeit, die Dokumentation in den Quellcode einzubetten. Auf diese Weise kannst du sie während der Arbeit schreiben, und wenn sich Dinge ändern, ist es einfacher, die Dokumentation mit dem Code in Einklang zu bringen.

Mit dem Tool Javadoc kannst du die Dokumentation aus deinem Quellcode extrahieren und gut formatierte HTML-Seiten erstellen. Dieses Tool ist im Java-Compiler enthalten und wird häufig verwendet. Die offizielle Dokumentation für die Java-Bibliothek wird sogar von Javadoc erstellt.

Dokumentation lesen

Schauen wir uns zum Beispiel die Dokumentation für Scanner an, eine Klasse, die wir in "Die Scanner-Klasse" zum ersten Mal verwendet haben . Du kannst die Dokumentation schnell finden, indem ...