JavaDoc

http://pp.info.uni-karlsruhe.de/lehre/W ... rn/b06.pdf
Antworten
Blurio
Beiträge: 56
Registriert: Do 20. Nov 2008, 21:39

JavaDoc

Beitrag von Blurio »

Ahoyhoy,

was genau schreib ich alles in Javadoc rein?
Nur sowas:
/**
*
* @return Entfernung zum Ursprung
*/

oder noch Kommentare a la:

/**
* Rechnet die Entfernung des Punktes zum Ursprung aus.
* @return Entfernung zum Ursprung
*/

Vielen Dank schonmal.

Edith meint: Ach bleh, für fünf Minuten Wikipedia bin ich mir zu schade. Hat sich dementsprechend erledigt.
Tankwart
Beiträge: 133
Registriert: Do 20. Nov 2008, 13:56

Re: JavaDoc

Beitrag von Tankwart »

Muss ich eigentlich, wenn ich im Interface alle Methoden kommentiert hab, das auch noch in den einzelnen Klassen machen?
Erscheint mir ziemlich sinnfrei, aber der Praktomat checkstyle zeigt das als Fehler an. :no:
Christian S.
Beiträge: 225
Registriert: Sa 25. Okt 2008, 12:48

Re: JavaDoc

Beitrag von Christian S. »

Tankwart hat geschrieben:Muss ich eigentlich, wenn ich im Interface alle Methoden kommentiert hab, das auch noch in den einzelnen Klassen machen?
Erscheint mir ziemlich sinnfrei, aber der Praktomat checkstyle zeigt das als Fehler an. :no:
Schau mal in die Newsgroup, du darfst wohl @inheritDoc benutzen.
Antworten

Zurück zu „Blatt 6 - Abgabe 06.02.09“