DVG Kommentare1 Kommentare

DVG Kommentare 2 Kommentare Es gibt zwei Arten von Kommentaren: einzeilige Kommentare // der Kommentar geht bis zum Ende der Zeile mehrzeilige Kommentare /* Der Kommentar beginnt mit /* und endet mit */

DVG Kommentare 3 // Das ist das berühmte Hello world - Programm public class Hello { /* Mit der Methode main beginnt die Abarbeitung jedes Programmes. */ public static void main (String [] args) { /* * out ist das Standardausgabe-Objekt auf dem * aktuellen Rechner. * Die Methode println gibt eine Zeichenkette und * einen Zeilenvorschub auf das Objekt out aus. */ System.out.println("Hello, world!"); } }

DVG Kommentare 4 Dokumentations-Kommentare /** * beginnen immer mit /** * und enden mit */ werden vor Klassen-, Variablen- und Methoden-Definitionen von dem Tool javadoc interpretiert und zum Erstellen einer Dokumentation in Form von HTML-Dateien benutzt. *, Leerzeichen und Tabulatorzeichen am Zeilenanfang werden ignoriert. HTML Text kann beliebig eingesetzt werden. Spezielle tags beginnen und werden besonders interpretiert. Der erste Satz enthält die Kurzbeschreibung. Der Rest die ausführliche Beschreibung. Können HTML-Tags außer.. und enthalten.

DVG name-text vor Klassen-Definitionen Informationen werden als Autor-Informationen in die Dokumentation übernommen. Mehrere author-tags können hintereinander angegeben werden. author-tags werden übernommen, wenn javadoc -author benutzt wird. MA1 TFH HerbstSemester 2000/2001 ==> Author: MA1 TFH HerbstSemester 2000/2001

DVG deprecated-text vor allen Definitionen Das mit dem deprecated-tag gekennzeichnete Objekt wird in einer späteren Version des Programmes möglicherweise nicht mehr enthalten sein. In dem Text kann angegeben werden, welches andere Objekt die Funktion übernimmt. Falls es keinen Ersatz gibt, sollte No replacement angegeben werden. wird ersetzt durch Equation.fs ==> Deprecated. wird ersetzt durch Equation.fs

DVG @exception class-name description vor Methoden-Definitionen In der Methode wird die Ausnahme class-name nach außen weitergereicht. Keine Ausnahmen ==> Throws: Keine - Ausnahmen

DVG parameter-name description vor Methoden-Definitionen Beschreibt die Parameter einer Methode. Als Beschreibung kann beliebiger Text zur Erläuterung Bedeutung und der Funktionsweise des Parameters angegeben werden. args Enthält die Parameter, die beim Start des Programmes übergeben werden. ==> Parameters: args - Enthält die Parameter, die beim Start des Programmes übergeben werden.

DVG description vor Methoden-Definitionen Beschreibt den return-Wert einer Methode. Als Beschreibung sollten Typ und Wertebereich des return-Wertes angegeben werden. float - Nullstelle der Funktion f. ==> Returns: float - Nullstelle der Funktion f.

DVG name label vor allen Definitionen Erzeugt eine Referenz auf ein anderes Objekt. Mögliche Formen package.class#member label Referenz auf ein anderes label Referenz auf ein "string allgemeine Referenz, z.B. auf ein Buch oder Artikel Hello#main main ==> See Also: main

DVG Kommentare name label} vor allen Definitionen Kann genauso verwendet werden wie das see-tag, nur daß die Referenz im Text erzeugt wird und nicht als extra Absatz. Beispiel: Zur Berechnung der Nullstelle nutze man die Methode equation#newton newton} der Klasse equation equation}. ==> Zur Berechnung der Nullstelle nutze man die Methode newton der Klasse equation

DVG since-text vor allen Definitionen Erläutert seit wann das entsprechende Objekt verfügbar ist. Version ==> Since: Version 1.1.6

DVG version-text vor Klassen-Definitionen Gibt die Version der Klasse an. version-tags werden übernommen, wenn javadoc -version benutzt wird. 1.0 ==> Version: 1.0

DVG Kommentare 14 class-name description name parameter-name field-name field-type class-name version-text

DVG Kommentare 15 Zusammenfassung

DVG Kommentare 16 javadoc Das Tool javadoc erzeugt aus den Dokumentations-Kommentaren eine Dokumentation. Aufruf z.B.: javadoc -author -version -d dokumentation *.java erzeugt aus allen java-Files des aktuellen Verzeichnisses die Dokumentation und legt diese im Unterverzeichnis dokumentation ab.

DVG Kommentare 17 javadoc-Parameter -author: werden ausgewertet. -version: werden ausgewertet. -private: Alle Klassen, Variablen und Methoden werden in die Dokumentation übernommen. -windowtitle title-text: Titel der Dokumentation. -d Verzeichnis: Die Dokumentation wird in das angegebene Verzeichnis geschrieben. file1 file2... fileN: java-Quellen die ausgewertet werden. Z.B.: javadoc -author -version -private -d Dokumentation Newton1.java Newton2.java Newton3.java

DVG Kommentare 18 Parameter können in eine Datei geschrieben werden. Z.B: Datei Newton.dat enthält -author -version -private -title Newton-Verfahren -d dokumentation Newton1.java Newton2.java Newton3.java Dann kann die Dokumentation erzeugt werden durch