Wie dokumentiere
ich meine JAVA-Programme?
Zur Dokumentation
der eigenen JAVA-Programme kann man den Dokumentationsgenerator javadoc
benutzen.
javadoc
erstellt
aus den Java-Quelldateien korrespondierende Dokumentationen im HTML-Format,
welche sich mittels eines geeigneten Browsers (z.B.
Netscape)
ansehen lassen.
javadoc
wertet zur Erstellung der HTML-Dokumentationen die öffentlichen Klassen-,
Interface- und Methodendeklarationen aus sowie benutzereigene Dokumentationskommentare.
Der Aufruf von javadoc und die nötige Aufbereitung der Java-Quellen
werden beschrieben unter "javadoc Beschreibung".
(--> gewünschte Beschreibung bitte anklicken!)
(Sigrid Wehner / Mai 2002)