Dokumentationscomments

[Han]

Hallo....ich frage mich wozu ich diese Dokumentationscomments brauche......

also z.b.:

 /** Hallo ich bin da*/

Was ist der Unterschied zu normalen Comments bzw. was bringen mir diese Comments...danke...

mfg,
Hannes[/code]

 

[Roar]

mit /** werden javadoc kommentare eingeleitet.

edit: hum, dem titel nach zu urteilen wusstest du das schon?

 

[Beni]

Na, mit Dokumentationscomments erzeugt man eine Dokumentation :wink:

Hier wie das geht, hier ein Beispiel.

 

[Han]

OK..ich hab jetzt schon ein paar Dokumentationskommandozeilen geschrieben in Eclipse aber irgendwie werd ich nicht recht schlau draus....auch aus der Dokumentation nicht. Wenn ich z.b. meine Dokumentationskommandozeilen geschrieben habe wo sehe ich dann die erstellte HTML Seite? In Eclipse Workspace ist sie auf jeden Fall nicht.

mfg,
Hannes

 

[Beni]

Wenn du bei Eclipse über "Project > Generate Javadoc" gehst, musst du:
a) im Projektebaum links sicherstellen, dass alle Dateien ein Häcklein haben, von welchen du eine Doku möchtest
b) das bei Destination (unten) ein Pfad eingetragen ist, den du später besuchen kannst... :wink:

 

[Han]

Hallo....ok und was much ich bei javadoc command eingeben?

Danke..

mfg,
Hannes

 

[Beni]

Der Pfad zu dem "javadoc"-Programm. Also z.B. "/opt/jdk1.5.0_06/bin/javadoc" (es ist immer in dem "bin"-Ordner des JDKs).

 

[Han]

Hallo....danke...gut dann erstellt es mir praktischerweise so eine HTML Seite mit alle den Klassen und Methoden welche ich in meinem Programm implementiert habe.....und wie schreibe ich jetzt was zu den Methoden hinzu, also kann sie beschreiben? Dafür habe ich gedacht sind die Comments da als z.b.


/**macht was**/
void methode(){
....
}

...aber im javadoc schreibts dann nichts hin...was mach ich falsch...???

mfg,
Hannes

 

[Han]

OK..geht doch....

Aber bei generate javadoc stört mich dass ich jeweils nur public, private,....auswählen kann aber nicht alle gleichzeitig....wie geht das, dass wirklich alle Methoden die ich in der Klasse verfasst habe angezeigt werden...??

mfg,
Hannes

 

[Beni]

Probiers zuerst mal genauer aus, bevor du reklamierst... (es ist die minimale Sichtbarkeit gemeint :wink

 

[Han]

OK..stimmt....danke.....wie schauts eigentlich mit dem rechtlichen aus....darf ich z.b. von meinem Programm die Javadoc Dateien auf einen Server hochladen oder ist dass nur Sun vorenthalten?

mfg,
Hannes

 

[Beni]

Mit der Doku (und dem Programm) kannst du machen, was du willst.
Ok, es gibt eine Ausnahme: du darfst damit keine nuklearen Anlagen steuern, aber wahrscheinlich hattest du das auch nicht vor :bae:

 

[Han]

... :wink: ...danke
:wink:
mfg,
Hannes