JavaDoc
by nex on 1/4/05, 9:28 PM in doku
Ich habe soeben Quellcode mit (gegenüber der letzten Version) erweiterter JavaDoc veröffentlicht. Der neue Stylesheet sieht so aus, als ob dem Dokument schlecht wäre – dies ist kein Zufall. Ich werde aber noch etwas daran tun; bitte helft mit, indem ihr eure Klassen dokumentiert.
Ihr könnt meine Doc-Kommentare als grobe Vorlage nehmen, aber beachtet bitte, dass sie nicht ganz vollständig sind; seht das also als den Mindest-Standard an. Wie es wirklich geht, steht in
und- javadoc - The Java API Documentation Generator (direkter Link zum wichtigsten Abschnitt)
Um Fehler zu vermeiden / ausfindig zu machen, könnt ihr auch das DocCheck Doclet verwenden. (Anleitung hierzu.)
|