Vorstellung von: Javadoc

Vorstellung von:
Javadoc
•
• Tobias Fritsch
Softwarepraktikum 2002
Was macht Javadoc ?
haben: speziell
kommentierten Java
– Source
*wichtig: an die Konventionen
halten!
bekommen: HTML
basierte API zu
unserem Programm
Wozu dient Javadoc?
• Dokumentation/ Nachvollziehbarkeit von
größerem Code
• Parallelarbeit
• Gedächtnisstütze
• Übersicht
• Wiederverwendbarkeit
Wo und seit wann gibt es
Javadoc?
• Javadoc im JDK seit Version 1.1 vorhanden
• Aufruf direkt über den Befehl „javadoc ...“
Beispiel für einen
dokumentierten Source:
/**
* Programm zum Bestimmen spezifischer Vogelgesaenge.
* Hier am Beispiel von Specht und Nachtigall.
* Erschaffungsklasse zum Erstellen verschiedener Objekte.
* @author Tobias Fritsch
* @version 1.0 25 Apr 2002
*/
public class vogelgesang {
/**
* Hauptprozedur, die die eigentlichen Funktionsaufrufe macht.
* @param args eingegebener Aufrufsstring
* @todo Weiterer Ausbau der Hauptfunktion - mehr Voegel includen
*/
public static void main (String[] args) {
/** instance1 Nachtigall sei Instanz der Unterklasse */
SingVogel v1 = new Nachtigall();
// 2 Objekte erschaffen
etc etc etc ....
Klassenansicht:
Klasseninformationen:
Detailinformationen: