JavaDoc: Spezielle Beschreibung nur in Method Detail

[ghummelll]

Hallo Leute,

ich bin gerade dabei, meinen Code aufzuräumen, zu kommentieren und dokumentieren. Nun möchte ich bei der Beschreibung einer Methode eine allgemeine Beschreibung in der Method Summary und bei Method Detail eine konkretere Beschreibung inkusive "Anleitung" schreiben. Hoffe, ihr versteht, was ich meine.

Beispiel: Graphics (Java 2 Platform SE v1.4.2) - dort machen die das beispielsweise im Konstruktor. Da muss es doch irgendwas geben... Oder passen die solche Sachen dann per Hand an?

Ich hoffe, mir kann jemand helfen. Bis dahin einen schönen Abend und viele Grüße aus Weimar...

 

[SlaterB]

die Javadoc-HTML-Datei erzeugt dir ein Programm namens javadoc

für die Kurzbeschreibung, die entweder immer da ist oder per Schalter aktiviert werden kann,
wird glaube ich einfach der erste Satz aus der Doku der Methode gewählt

 

[ghummelll]

für die Kurzbeschreibung, die entweder immer da ist oder per Schalter aktiviert werden kann,
wird glaube ich einfach der erste Satz aus der Doku der Methode gewählt

Leider nicht. Hab mal nen Screenshot gemacht:

Eigentlich sollte in dieser Kurzbeschreibung nur Folgendes stehen:
"For testing quickly new sensors do following steps:"
Dass der Rest dann unten steht (soll übrigens eine Ordered List sein, aber das wird da oben ja leider nicht angezeigt), kann sich der Leser dann ja denken...

 

[SlaterB]

Konkretisierung: 'der erste Satz' bedeutet alles bis zum ersten Punkt,
wobei deine 0.01 anscheinend nicht dazuzählen, sei es es durch die Zahlen, durch die Klammern oder durch die Formatierung,
kann man ja alles testen

eine Änderung dieser Regel habe ich eben spontan nicht unter den javadoc-Parametern gesehen, aber kannst noch mal genauer nachschauen

 

[ghummelll]

Dankeschön!! Daran lag es...

 

[musiKk]

Und hier nochmal die erste Anlaufstelle für solche Fragen: die Dokumentation

This sentence ends at the first period that is followed by a blank, tab, or line terminator, or at the first tag (as defined below).

etc...