[beny_mcde]

hello again,
ich habe eine größere ansammlung von selbstgeschriebenen klassen,
die ich mit javadoc kommentaren ausstatten will,
war wohl am anfang zu faul kommentaren zu schreiben...

jetzt möchte ich mir die arbeit machen und alle funktionen dokumentieren...
aber natürlich so einfach wie möglich .
also meine frage, gibt es ein tool mit dem man für eine angegebene menge
von klassen javadoc tags erzeugen kann?

ein methoden kommentar sieht z.b. so aus

/** initiates multilang support and sets a specified language base dir and a default language
  * @param String baseDir - base dir for all language files
  * @param String defaultLanguage - default language
  * **/

wenn man das jetzt für jede methode in jeder klasse selbst schreiben muss ist das ziemlich viel arbeit...
nützlich währe es hier wenn man die gerüste, automatisch erzeugen könnte

/** 
  * @param String 
  * @param String 
  * **/

dieser teil automatisch erzeugt würde schonmal viel schreibarbeit (copy&paste) übernehmen.
auch eine funktion jede klasse eine einheitlichen header hinzufügen zu können währe hilfreich...

mfg beny

[ehli75]

Nimm doch einfach Eclipse dafür. wenn du in der Zeile über deiner Methode /** schreibst + Enter, wird automatisch genau so vervollständigt, wie du es haben willst.

[beny_mcde]

nice... mal wieder liegt die lösung ganz nah...
seit eclipse 3.1 habe ich netbeans verlasen, aber das feature ist mir noch nicht aufgefallen.....

wie seht es aus mit dem klassenheader?
oder muss ich den einzeln in jede klasse einfügen?
es gibt ja sowas wie code templates, das funtzt aber ja nur wenn man eine neue klasse erstellt..

[ehli75]

Klar geht das für die Klassen auch ... einfach in der Zeile direkt über der klassendefinition "/**" + Enter ... und schon kommt ein kompletter Block daher. Da steht aber nur @author und TODO drin ... vielleicht kann man das ja irgendwo festlegen (bin ich mir ziemlich sicher das das geht).
Javadocs kann man für alles mögliche erzeugen lassen ... ahb grad mal probiert ... einfach die Variable, Methode, Klasse ... markieren, rechts Klick und dann unter Source "Add JavaDoc comment" auswählen ... und das war's.

[sparrow]

Hmm... gibt es diese Option eigentlich bei Eclipse 3.1 nicht mehr?
Bei mir gibt es nur noch "add comment", nicht "Add JavaDoc comment".