Grundlagen der Informatik 1 – T14

Grundlagen der Informatik 1 – JavaDoc
Grundlagen der Informatik 1
JavaDoc-MiniIntro
Prof. Bernt Schiele
Dr. Guido Rößling
Reliable basic
Services Group
(RBG)
JavaDoc: Allgemeines
Reliable basic
Services Group
(RBG)
Grundlagen der Informatik 1 – T14
• Bei Nutzung der korrekten Notation kann Java
automatisch Dokumentationen in HTML erzeugen
• Möglich für alle „nach außen“ sichtbaren Elemente:
–
–
–
–
Klassen
Konstante
Klassen- und Objektattribute
Methoden
• Grundlegende Notation: vor dem Element steht ein
Kommentar folgender Form
/**
* Kommentartext
*/
2
Sonderformate
Reliable basic
Services Group
(RBG)
• Es gibt zahlreiche Sonderbefehle
– Fangen immer mit „@“ an
• Diese gehören in eine eigene Zeile des Kommentars
Grundlagen der Informatik 1 – T14
– „*“ am Anfang der Zeile nicht vergessen 
• @param x text
– Kommentar „text“ zu Parameter „x“
• @return text
– Kommentiert, was diese Methode zurückgibt
– Natürlich nur sinnvoll, wenn die Methode nicht void ist!
• @author text
– Autorangabe, oft in Form „Name <email>“
3
Sonderformate II
Reliable basic
Services Group
(RBG)
• @throws type text
– Auslösen einer Exception ( T18) mit Angabe von Typ und
„wann / warum“ das passieren kann
• @version double
Grundlagen der Informatik 1 – T14
– Angabe der Versionsnummer
• @since text
– Angabe, seit wann diese Version existiert
– Im JDK oft „1.5“: erst seit Java 1.5/5.0
• @see Referenz
– Querverweis auf andere Elemente
– Bei anderer Klasse: @see packagenamen.Klasse#Methode
– Methoden mit Parameter: Angabe mit Typ der Parameter
• Z.B. als m(int, String, double)
4
Grundlagen der Informatik 1 – T14
Beispiel
Reliable basic
Services Group
(RBG)
/**
* This method will sort the array passed in, thus
* changing its elements.
* Uses quicksort(array, 0, array.length-1) for sorting.
*
* @param array the array to be sorted
* @throws IllegalArgumentException if the array is null
* @author Guido Roessling [email protected]
* @version 0.2
* @see #quicksort(array, int, int)
*/
public void quicksort(int[] array) { /* … */ }
5
Doku
Reliable basic
Services Group
(RBG)
Grundlagen der Informatik 1 – T14
Viel mehr dazu finden Sie unter
http://java.sun.com/j2se/1.5.0/docs/tooldocs/window
s/javadoc.html#@see
(Oder einfach per Google mit „JavaDoc“ )
6