Programm-Dokumentation mit JavaDoc

[July]

Ich muss in diesem Semester eine Hausarbeit schreiben und zwar ist die Aufgabenstellung, dass ich ein Text-Adventure in Java schreiben soll (mit dem Programm BlueJ, falls das einer kennt). Naja, dürfte wohl hinzukriegen sein.
Schriftlich sollen wir natürlich auch was abgeben, Lösung des Adventures, Skizze der Räume etc.
Dann steht da noch, dass ich 'eine Dokumentation, die Sie mit JavaDoc angefertigt haben' abgeben muss.
Hab auch ne PDF-Datei bekommen, die sich mit dieser Programmdokumentation beschäftigt, aber irgendwie versteh ich nicht wirklich was das eigentlich ist. Schreibe ich diese Dokumentation selbst per Hand oder kann man die irgendwie automatisch erstellen?
Schreib ich die Kommentare direkt in den Quellcode und ist das ganze mit diesen merkwürdigen Tags bloß eine besondere Form, meinen Quellcode zu kommentieren oder wie?
Da steht auch noch, dass man diese doc comments formatiert und das typischerweise mit HTML.
Hat da irgendwer Ahnung davon, was das ist, was ich da machen muss? *irgendwie nen Brett vorm Kopf hat* Ich kann zur Not vielleicht auch noch mal die PDF-Datei besorgen, hab sie im Moment leider nur ausgedruckt, kann sie aber, falls es wen interessiert und mir jemand helfen möchte (biiiiiitteeee) noch hochladen.
Joa, das wars auch erstmal schon

[Latency]

Im Grunde ist es reicht einfach.

Einfach vor deine Klasse, oder vor die Funktion einen /** */ Kommentar Block setzen.

Ich schreib am besten ein kleines Beispiel

Code:

/** Beschreibung der Funktion (sollte aber kurz gehalten werden da mehrzeilige Beschreibungen nicht angezeigt werden, falls doch weiß ich nicht wie )
@param Inhalt Liefert Bla bla bla
@param Test ldk kdj fjkd
@return Gibt bla bla zurück
*/
static function String Testfunc(String Inhalt, Char Test)
{
System.out.println(Inhalt + Test);
return Test;
}

Die Doku erstellst du mit BlueJ indem du oben in der Menü Leiste bei (Achtung jetzt muss ich raten) Project auf Documentation gehst. Es werden dann sofort alle vorhandenen klassen und Funktionen die Dokumentiert sind dokumentiert und dir ein HTML Dokument vor die Nase gesetzt.

[July]

Aaaah, vielen vielen Dank
Du bist meine Rettung *g* Jetzt versteh ich endlich was der von mir will.

Danke! Wenn ich Fragen hab, meld ich mich nochmal Aber jetzt dürfte das soweit erstmal klar sein

[Latency]

Ich hab dir mal ne Auflistung aller JavaDoc Tags rausgesucht.
http://java.sun.com/j2se/1.5.0/docs/...ml#javadoctags

[Ineluki]

kannst du mal noch sagen, was blue ist, hast mich neugierig gemacht ...

[July]

Ist irgendein Programm, mit dem man Java machen kann, ich habs mal eben auf meinen Webspace hochgeladen, wenn du magst, kannst dus dir ja mal runterladen und angucken

Hab dir das 'tolle' Test-Adventure, was wir von unserem Dozenten bekommen, auch mit hochgeladen, damit du was zum Angucken hast, wies da drin so aussieht. *g*
Musst das RAR-File entpacken und dann über BlueJ den 'Ordner' Zork1 öffnen. (Also das Programm liest den ganzen Ordner irgendwie, aber das muss ich dir wahrscheinlich nicht erzählen, du bist ja eher der Profi als ich ) Hoffe, es klappt alles. Kannst mir ja sonst auch ne PN schicken oder so.


@Latency: Danke Werd mir das morgen mal in aller Ruhe anschaun.