✔ Effizient arbeiten mit JavaDoc und eclipse

M

munuel

Mitglied
Hallo und frohe Weihnacht,
Ich habe mir ab dem neuen Jahr vorgenommen alles zu kommentieren was ich programmiere! Und dafür möchte ich JavaDoc benutzen, was auch alles wunderbar funktioniert unter eclipse.
Meine Frage:
Gibt es eine Möglichkeit wodurch ich durch Klicken oder noch besser einen Hot-Key einen Kommentargerüst generiert bekomme.
Da ja die Kommentarte von Klassen leicht mit denen von Methoden abweichen muss ich immer in schon kommentierten Klassen nachschauen wie die Notation war. (z.b das @version vor @autor kommt!).
Viele Grüsse munuel
 
Hi!

Das ist ein guter Vorsatz für's neue Jahr :)

Du kannst mit der Tastenkombination ALT+Shift+J Javadoc zu der Klasse, den Methoden und den Variablen generieren lassen. Der Cursor des Editors muss sich dafür auf dem entsprechenden Element befinden.

Gruss
ben
 
Hallo!

Du kannst auch die zu kommentierenden Elemente im Outline der Klasse auswählen und dann Alt+Shift+J drücken. Dadurch wird für jedes selektierte Element ein entsprechender Kommentar Block erzeugt.

Gruß Tom
 
hallo,
Ja danke für den Tipp.
Das hat mir weitergeholfen. Ich habe noch folgende Frage.
Diese automatischen Kommentare würde ich noch gerne anpassen.
Ich habe im eclipse Preferences->Java->Editor->Templates gefunden!
Klappt auch wunderbar!
Dort gibt es auch Insert Variables wo man z.B durch @author ${user} den User setzen kann anscheinen nimmt er standartmässig den User-Name mit dem ich eingeloggt bin. Das würd ich gerne ändern und auch versuchen meine eigenen Insert Variablen im eclipse anlegen. :-)

Ich kenn auch von JBuilder so ein todo Liste wo man auf einen Schlag alle @todo oder TODO marker angezeigt bekommt, unter eclipse macht er mir zwar einen Haken an der Seite ,aber dann muss man ja trozdem alle Klassen nach Todos durchschauen! Gibts da vielleicht auch noch einen Trick :-)

Viele Grüsse munuel
 
Jeder Kommentar, der TODO enthält wird mit dem auf TODO folgenden Text in der Liste der Tasks (Window > Show View > Tasks) angezeigt.

Du kannst Dir unter "Window > Preferences + Java + Task Tags" weitere Tags für Todos mit verschiedenen Prioritäten eintragen.

Gruß hpvw
 
hallo,
Erst mal Danke für die super Tipps.
Das die TODO's mit den Tasks verwaltet werden find ich sogar besser als beim JBuilder!
Das ich die Insert Variablen ${user} anscheinen im eclipse nicht definieren kann, die unter templates benutzt werden ist auch nicht so schlimm. ( hab jetzt zum x-ten mal dei Einstellungen durchgeschaut)
Ich schreibe in einem Template wo ich mir ein Kommentargerüst geniere meinen richtigen Namen mit Nachnamen einfach rein.
Sonst würde er in den Kommentaren immer den Namen benutzen mit dem ich mich einlogge!
Viele Grüsse munuel
 
Um antworten zu können musst du eingeloggt sein.

Neue Beiträge

Zurück