Javadoc - Feldkommentare

[DarthShader]

Hallo,

ich bin z.Z. dabei, ein recht großes Programm ordentlich mit Javadoc zu kommentieren. Ich habe zuvor noch nicht mit Javadoc gearbeitet, wohl aber mit Doxygen.

Javadoc erwartet den Kommentar ja immer vor dem zugehörigen Feld/der Methode/der Klasset etc.. . Wenn ich nun eine Klasse habe, in der sehr viele Member aufgelistet sind, so bläht sich der Code unglaublich auf, wenn ich vor jeden Member eine Javadoc Zeile schreibe. Innerhalb der Doku ist es natürlich übersichtlich, aber ich will den Code ansich nicht so unübersichtlich haben. Deshalb die Frage - gibt es eine Möglichkeit, Javadoc zu sagen, dass der Kommentar sich auf ein Objekt bezieht, welches sich _vor_ dem Kommentar befindet? So könnte ich übersichtlich hinter alle Member den Kommentar schreiben, z.B:

private String meinLabel = ""; /** Dies ist ein Beispiel Kommentar, der zu meinLabel gehört */


Vielen Dank

 

[MatthiasUtsch]

Hi Darth Shader

schau dir mal den Link an den ich unten angeführt habe, da steht alles wissenswerte über javadoc drin, hoffe es hilft dir!

http://java.sun.com/j2se/javadoc/writingdoccomments/

 

[DarthShader]

Hallo,

danke für den Link, ich habe mir das ganze Ding nun angesehn, kann aber noch nicht daraus sehen, ob mein Vorhaben überhaupt möglich ist. Wie es aussieht, ist es das nicht - oder kennt jemand noch eine Möglichkeit?

 

[nireus]

ich hab noch nirgends was davon gelesen, dass das geht...
aber wenn du ein ide wie eclipse oder so benutzt kannst du doch mit dem kleinen + links am editor codeblöcke minimieren.
das geht auch mit javadockommentaren - so kannst du jeden deiner kommentare optisch auf eine zeile reduzieren egal wie lang die in wirklichkeit sind