Eclipse JavaDoc Template

[jared]

Hi!!!

Über Window->Preferences->Java->CodeStyle->Code Templates kann man ja für z. B. Methoden ein Style hinterlegen, wie der kommentar aufgebaut sein soll. Dann muss man nur noch alt + shift + j drücken und schon wird der Kommentar über der Methode angezeigt. Soweit die Theorie. In der Praxis funktioniert dies aber nicht. Bei mir kommt immer nur eine Zeile mit der Paketstruktur.
Was mache ich falsch oder wo muss ich noch was einstellen?? Denn alles von Hand zu machen, Parameter hinzufügen, return parameter hinuufügen für die javadoc ist ganz schön lästig.

Ich hoffe jemand kann mir da weiterhelfen.

Ich benutze Eclipse Helios 3.6.

mfg

 

[Atze]

hast du die methoden denn mit javadocs versehen?

setz den cursor mal eine zeile über die methode, tippe "/**" und drück enter! bling!

 

[jared]

Ja. wenn ich das mache dann erstellt er mir nur folgendes:
/**
*
**/
und weiter??

 

[Atze]

hat die methode denn parameter und / oder n rückgabewert?

du kannst auch noch so sachen wie @author, @version etc angeben.

wenn du @-strg-leertaste drückst, sollte er die eigentlich die möglichen annotations vorschlagen

 

[jared]

und des zeugs kann man nicht als template für alle Methoden hinterlegen??
Also als ich testweise mal @param gemacht habe und den Attributsnamen hinten hingeschreiben habe, hat er beim erzeugen der javadoc gesagt, das er den nicht kennt, als warnung.
WEil wenn ich immer alles per hand eingeben muss, ist ja auch doof. ICh dachte da kann ma ein Template hinterlegen und dann einfach shift + alt + j, fertig.

 

[Atze]

selbst wenn, klar kann er sich die parameternamen automatisch ziehen, und den rückgabewert auch. aber javadocs sind ja dazu da, dem leser den code, bzw die funktion der methode zu erklären. das musst du wohl manuell machen, woher soll javadoc wissen, was du dir bei dem code gedacht hast?

*edit*: wenn du im team dran arbeitest, machs direkt in englischer sprache. damit tust du dir und den potentiellen benutzern einen gefallen. falls den code mal ein nicht-deutschsprachiger mitarbeiter in die finger bekommt, kann er entweder nix damit anfangen oder er ist hierarchisch in der position, dich dazu zu zwingen, das ganze nochmal zu übersetzen!

 

[jared]

Ja, mit dem individuellen hast du recht. Aber du hast ja Übergabeparameter und/oder rückgabewerte und diese meine ich, kann er doch automatisch über @param einfügen oder?? Denn den Text hierfür muss ich so oder so schreiben, nur ist es finde ich unnötige Arbeit, die namen abzuschreiben oder zu kopieren.

mfg

 

[andiv]

Füge unter Code-Templates in dein Template ${tags} ein und dann generiert dir Eclipse "@return" und "@param name". Ist es das was du gesucht hast?

 

[jared]

Ja. Nur das er das eben bei mir nicht macht. Ich kann eingeben was ich will und eclipse macht das nicht.

 

[Atze]

hast du irgendwas an den eclipse settings verändert?

 

[andiv]

Wirklich viele Informationen lieferst du ja nicht gerade. Kopier doch mal dein Code-Template hier ins Forum, dann können wir das bei uns auch ausprobieren.

 

[jared]

Jetzt machts eclipse. Habe gestern wohl vergessen eclipse neuzustarten.

Thanks.

 

[Atze]

juhu! bitte als gelöst markieren!

 

[jared]

Habe doch noch folgendes Problem mit eclipse. Wenn eclipse mir automatisch z. B. getter und setter erzeugt, wird mein dummy comment eingefügt, wenn ich aber eine bestehende Methode markiere und dann den shortcut oder über dass context menu versuche diesen comment hinzuzufügen, dann macht er dies nicht richtig.

Woran könnte dies liegen??

 

[andiv]

Das sind verschiedene Codetemplates. Hast du nur die für automatisch generierte Getter und Setter geändert oder auch die für normale Methoden?

 

[jared]

eigentlich generell unter methods. und dort habe ich den haken gesetzt, dass er bei neuen methoden die comments automatisch einfügen soll.

 

[andiv]

Unter Java -> Code Style -> Code Templates gibt es bei mir Constructors, Methods, Overriding methods, Delegate methods, Getters und Setters. Schau mal ob da das Pattern auch jeweils so wie du es haben willst eingestellt ist.