DVG1 - 11 - Kommentare 1 Kommentare. 2 Kommentare Es gibt zwei Arten von Kommentaren: einzeilige Kommentare // der Kommentar geht bis zum Ende der Zeile.

Präsentation zum Thema: "DVG1 - 11 - Kommentare 1 Kommentare. 2 Kommentare Es gibt zwei Arten von Kommentaren: einzeilige Kommentare // der Kommentar geht bis zum Ende der Zeile."—  Präsentation transkript:

1 DVG1 - 11 - Kommentare 1 Kommentare

2 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 */

3 3DVG1 - 11 - Kommentare // 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!"); } }

4 4DVG1 - 11 - Kommentare 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 mit @ 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.

5 5DVG1 - 11 - Kommentare@author @author name-text @author name-text vor Klassen-Definitionen vor Klassen-Definitionen Informationen werden als Autor-Informationen in die Dokumentation übernommen. Mehrere author-tags können hintereinander angegeben werden. Informationen werden als Autor-Informationen in die Dokumentation übernommen. Mehrere author-tags können hintereinander angegeben werden. author-tags werden übernommen, wenn author-tags werden übernommen, wenn javadoc -author benutzt wird. Beispiel: Beispiel: @author MA1 TFH Winteremester 2002/2003 ==>Author: MA1 TFH Winteremester 2002/2003

6 6DVG1 - 11 - Kommentare @deprecated @deprecated deprecated-text @deprecated deprecated-text vor allen Definitionen 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. 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. Beispiel: Beispiel: @deprecated wird ersetzt durch Equation.fs ==> Deprecated. wird ersetzt durch Equation.fs

7 7DVG1 - 11 - Kommentare @exception, @throws @exception class-name description @exception class-name description vor Methoden-Definitionen vor Methoden-Definitionen In der Methode wird die Ausnahme class-name nach außen weitergereicht. In der Methode wird die Ausnahme class-name nach außen weitergereicht. Beispiel: Beispiel: @exception Keine Ausnahmen ==>Throws: Keine - Ausnahmen

8 8DVG1 - 11 - Kommentare @param @param parameter-name description @param parameter-name description vor Methoden-Definitionen vor Methoden-Definitionen Beschreibt die Parameter einer Methode. Als Beschreibung kann beliebiger Text zur Erläuterung Bedeutung und der Funktionsweise des Parameters angegeben werden. Beschreibt die Parameter einer Methode. Als Beschreibung kann beliebiger Text zur Erläuterung Bedeutung und der Funktionsweise des Parameters angegeben werden. Beispiel: Beispiel: @param 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.

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

10 10DVG1 - 11 - Kommentare @see @see name label @see name label vor allen Definitionen vor allen Definitionen Erzeugt eine Referenz auf ein anderes Objekt. Mögliche Formen sind: Erzeugt eine Referenz auf ein anderes Objekt. Mögliche Formen sind: @see package.class#member label Referenz auf ein anderes Objekt @see label @see label Referenz auf ein URL @see "string allgemeine Referenz, z.B. auf ein Buch oder Artikel Beispiel: Beispiel: @see Hello#main main ==> See Also: main

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

12 12DVG1 - 11 - Kommentare @since @since since-text @since since-text vor allen Definitionen vor allen Definitionen Erläutert seit wann das entsprechende Objekt verfügbar ist. Erläutert seit wann das entsprechende Objekt verfügbar ist. Beispiel: Beispiel: @since Version 1.1.6 ==>Since: Version 1.1.6

13 13DVG1 - 11 - Kommentare @version @version version-text @version version-text vor Klassen-Definitionen vor Klassen-Definitionen Gibt die Version der Klasse an. Gibt die Version der Klasse an. version-tags werden übernommen, wenn version-tags werden übernommen, wenn javadoc -version benutzt wird. Beispiel: Beispiel: @version 1.0 ==>Version:1.0

14 14DVG1 - 11 - Kommentare Tags @author name-text @deprecated deprecated-text @exception class-name description {@link name label} @param parameter-name description @return description @see reference @since since-text @serial field-description @serialField field-name field-type field-description @serialData data-description @throws class-name description @version version-text

15 15DVG1 - 11 - Kommentare Zusammenfassung

16 16DVG1 - 11 - Kommentare 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.

17 17DVG1 - 11 - Kommentarejavadoc-Parameter -author: Die @author-tags werden ausgewertet. -version: Die @version-tags 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

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