Javadoc in Eclipse

[infors]

Hallo.
Ich bin auf dem Gebiet Javadoc noch Neuling. Nachdem ich eine Code implementiert habe bin ich in Eclipse auf export und Javadoc gegangen. Daraufhin wird auch ein Ordner namens Doc neu eingerichtet. Allerdings dachte ich, dass die Implementierung ergänzt wird, z.B. mit solchem Code:

/**
* Methodenbeschreibung - Methodenbeschreibung - Methodenbeschreibung -
*
* @return boolean
* @param text1 - String der ausgegeben wird.
* @param text2 - String dessen Länge überprüft wird.
* @throws Exception
* @see TestKlasse#printPicture
* @deprecated Bitte verwenden sie nur noch Sys.out.println(String text).
*/

In meiner getätigten Implementierung ist solch eine Ergänzung des Codes nicht zu finden.
Habt ihr eine Idee was ich falsch gemacht haben könnte?
Gruß
Peter

 

[XHelp]

hä? Du willst, dass er für dich selber sinnvolle javadocs generiert? oO
Ansonsten kannst du mit alt+shift+j dir javadoc "platzhalter" generieren lassen.

 

[infors]

Ich dachte das könnte Eclipse. Ist das jetzt nur manuell möglich. Wofür gibt es denn dann die Möglichkeit "Create Javadoc"?

 

[XHelp]

Du kannst ja im Package Explorer oder Outline mehrere (alle) Methoden auswählen und dann alt shift j drücken.
Für die Zukunft kannst du auch dein Template so einstellen, dass er dir gleich zu den Methoden JavaDoc Kopf macht.

[EDIT]
Gerade ergooglet: JAutodoc - Eclipse Plugin
[/EDIT]

 

[infors]

Puhhh, im Package Explorer habe ich das gemacht. Aber in meinem Quellcode wird sowas ähnliches immernoch nicht angezeigt...
/**
* Methodenbeschreibung - Methodenbeschreibung - Methodenbeschreibung -
*
* @return boolean
* @param text1 - String der ausgegeben wird.
* @param text2 - String dessen Länge überprüft wird.
* @throws Exception
* @see TestKlasse#printPicture
* @deprecated Bitte verwenden sie nur noch Sys.out.println(String text).
*/

HELP ;(

 

[XHelp]

Was wird da denn sonst angezeigt?
Willst du, dass Eclipse selber auf magische Art und Weise erkennt, wofür die Methode da ist und es dir im sauberem Deutsch hinschreibt?

 

[infors]

Ok, überzeugt. Dann kann Eclipse das nicht. Also habe ich das richtig verstanden, dass man diese Codes selber manuell eintippen muss?
Wärst du noch so lieb und würdest mir noch sagen was passiert, wenn ich auf File->Export->Java->Javadoc gehe? Da wird doch irgendwas generiert, aber was ist das dann?

 

[madboy]

Willst du, dass Eclipse selber auf magische Art und Weise erkennt, wofür die Methode da ist und es dir im sauberem Deutsch hinschreibt?

Das will ich auch haben ;(

@infors: über File->Export->Java->Javadoc exportiert Eclipse die javadoc-Kommentare als HTML. Das sieht dann so ähnlich aus wie hier: System (Java 2 Platform SE v1.4.2)

 

[infors]

Super! Danke für die Antwort. Man lernt wirklich nie aus.

Nur noch einmal Abschließend zur Sicherheit, obwohl es ansich ja klar ist. Das untere MUSS manuell von mir eingetippt werden, richtig?
/**
* Methodenbeschreibung - Methodenbeschreibung - Methodenbeschreibung -
*
* @return boolean
* @param text1 - String der ausgegeben wird.
* @param text2 - String dessen Länge überprüft wird.
* @throws Exception
* @see TestKlasse#printPicture
* @deprecated Bitte verwenden sie nur noch Sys.out.println(String text).
*/

 

[XHelp]

Naja, in deinem Quelltext schreibst du JavaDoc kommentare... und Javadoc export macht dir eine Sammlung von (idR) html Dateien, wo du dann die von dir eingegebenen Kommentare bestaunen kannst.
Du kannst dir die Tags wie @param, @return automatisch generieren lassen (alt shift j), aber Text musst du schon selber schreiben.

 

[Wookie81]

Nur noch einmal Abschließend zur Sicherheit, obwohl es ansich ja klar ist. Das untere MUSS manuell von mir eingetippt werden, richtig?

Jein. Wie XHelp schon geschrieben hat, kannst du dir den Rumpf des Kommentars generieren lassen. Aber alle Beschreibungen musst du dann selbst eingeben.

Wk

 

[REC]

Ich dachte auch das solche Sachen wie

@return KlasseX
oder

@param zahl1

selber geschrieben wird?

Also das Eclipse erkennt welche Variablen was machen in einer Methode.

 

[XHelp]

also @param zahl1 erkennt er ja auch, steht ja im Methodenkopf was du für Parameter haben willst...
Und warum soll es erkennen was die Methode macht?
Genau so gut könnte man die Idee weiterdenken:
Ich schreibe einen Javadoc, wo steht:

/**
* Berechnet die Quadratwurzel einer Zahl
* @param zahl eingegebene Zahl
* @return Quadratwurzel
*/

und Eclipse baut mir selber die Methode selber... hört sich unglaubwürdig an, oder?

 

[REC]

Ja klar.Das ist schon klar das dies nicht geht.

Aber eben Hauptsache er generiert diese

@param
@return

etc....
selber.

 

[XHelp]

Sicher kann das Eclipse (Netbeans bestimmt auch). Und wie gesagt, mit dem CodeTemplates bzw. Formatter kannst du es auch ganz bequem automatisch machen.