Frage zu JavaDoc

[htz]

Hallo,

ich möchte ein Programm von mir dokumentieren und suche nun ein Tool was mir dabei helfen soll Javadoc Kommentare zu erstellen. Das Tool sollte dann quasi automatisch schonmal die leeren kommentare bzw. standardmäßig ausgefüllten kommentare im code eintragen. Falls Javadoc das selber kann, wo finde ich die Funktion?

So war hatte ich mir das vorgestellt.

/**
 *
 *
 *
 * @param  url  
 * @param  name 
 * @return      
 * @see         Image
 */
 public Image getImage(URL url, String name) {
	try {
	    return getImage(new URL(url, name));
	} catch (MalformedURLException e) {
	    return null;
	}
 }

mfg
htz

 

[Wildcard]

Eclipse macht dir das (Alt + Shift + J)

 

[SlaterB]

in der IDE Eclipse ist da vieles vorhanden
wenn man vor einer Methode /** eintippt und Enter, dann wird ein Block mit Param und return erstellt,

geht vielleicht auch irgendwie automatisch für alle Methoden einer Klasse

einen @see Eintrag kenne ich bisher nur bei der automatischen Kommentierung bei der automatischen Erstellung bestimmter Methoden, z.B. Delegate

---------

@Wildcard
gibts dazu irgendwelche Einstellungen?
ich hab das bei mir mal ausprobiert, habe bei einer Methode den Kommentar entfernt,
der wurde nicht ergänzt,
stattdessen wurde ein zweiter Klassenkommentar eingefügt, obwohl schon vorhanden

edit: ach so, man muss die Methode markieren bzw. die Position des Cursors ist wichtig

 

[htz]

wie es halt so läuft... erst suche ich im forum, dann google ich und dann frag ich selber nach.. und wenn ich dann nochmal google, finde ich genau was ich gesucht habe


also knackpunkt an der sache ist, was ich vergessen hatte zu erwähnen, dass ich das alles ja nachträglich machen muss und dann nicht jede der methoden anklicken will und dauernd alt+shift+j drücken möchte. das grundgerüst der comments soll halt automatisch erstellt werden und ich scrolle noch durch und ergänze den text.

habe dazu nun ein eclipse plugin gefunden welches gut funktioniert. Es heisst JAutoDoc und zufinden ist es unter http://jautodoc.sourceforge.net

Danke für die schnellen Antworten!

mfg
htz

 

[SlaterB]

in max 15 Min hast du ein Plugin gefunden, installiert und für gut befunden?
diese Plugins muss ich mir auch mal anschauen

 

[Wildcard]

Ich würde das nicht automatisch tun, da es dann viel schwerer fällt zu entscheiden welche Methode schon kommentiert wurde und welche nicht. Dann genügt ein flüchtiger Blick nicht mehr. Mit dem automatisch generierten Zeug kannst du sowieso nichts anfangen wenn du es nicht editierst.