Programmieren in Java - HostFiXX.de

Programmieren in Java
! Logischer NOT-Operator
Abb.: Logische Vergleichsoperatoren
2.1.6 Kommentare, eingebettete Dokumentation
Es gibt drei Arten von Kommentaren
- Einzeilige Kommentare beginnen mit // und enden mit dem Ende der Zeile
- Mehrzeilige Kommentare (Blockkommentare) beginnen mit /* und enden mit */. Sie können sich über
mehrere Zeilen erstrecken.. Blockkommentare dürfen nicht geschachtelt sein.
- Dokumentationskommentare beginnen mit /** und enden mit */. Sie können sich ebenfalls über
mehrere Zeilen erstrecken und sind spezielle Kommentare, die für das javadoc-System benutzt
werden. Javadoc dient zum Erzeugen von API-Dokumentationen aus anderem Java-Quellcode.
Das JDK verfügt über das Dokumentations-Tool javadoc, das auf der Basis von
speziellen Kommando-Tags innerhalb einer Java-Quelltextdatei eine HTML-Datei als
API-Dokumentation der angegebenen Datei 151 oder des Pakets erzeugt.
Tag
@see [Klassenname]
@see
[Klassenname]#[Methodenname]
@param [Parametername]
[Beschreibung]
@version [Text]
@author [Name]
@return [Beschreibung]
@exception [Klassenname]
@deprecated [Ausdruck]
@since [Text]
Beschreibung
Dieses tag erzeugt einen Verweis in der HTML-Datei zu der
Klasse, die von Klassenname spezifiziert wird. Dabei kann der
Klassenname auch eine vollständige Pfadangabe sein
Dieses Tag erzeugt einen Verweis („See also“-Link) in der HTML-
Datei zu der Methode (innerhalb der mit Klassenname
spezifizierten Klasse), die von Methodenname spezifiziert wird
Dieses Tag dient zur Dokumentation der Parameter.
Parametername ist selbsterklärend, und die Beschreibung
spezifizeirt den Parameter. Geht die Beschreibung über eine Zeile
hinaus, so wird dies in der nächsten Zeile fortgeführt.
Mit diesem Tag kann die Version des Programms spezifiziert
werden.
Diese Tag fügt den Namen des Autors in die HTML-Datei ein
Mit diesem Tag kann der wert beschrieben werden, der von einer
Methode zurückgegeben wird
Dieses Tag erzeugt einen Link auf Ausnahmen, die von der
Klasse, die durch Klassenname spezifiziert ist, erzeugt werden.
Neu seit Version 1.1. Das Tag markiert eine Klasse, ein Interface,
ein Feld oder eine Methode als nicht verwendbar in weiteren
Anwendungen´. Bereits existierender Code wird trotz dieser
kennzeichnung weiter kompiliert und laufen, aber der Compiler
wird eine Warnung generieren,
Spezifiziert, wann das Release erstellt wurde.
Abb.: Die javadoc-Tags
Die Syntax von javadoc:
javadoc [Optionen] [Dateiname]
javadoc [Klassenname] [Paketname]
Falls ein Paketname angegeben wurde, dann dokumentiert javadoc alle Java-
Quelldateien innerhalb des aktuellen Verzeichnisses und anschließend das
151 vgl. 1.3.2.2, 3. Aufgabe
153