Javadoc

[Maho]

Kennt sich vielleicht wer mit Javadoc aus? Ich sitz schon seit zwei stunden am PC und versuch herausfinden, wie man die Kommentare im Programm mittels Javadoc als HTML erstellen kann.
Ich habe es schon mit MSDOS mit dem Befehl javadoc Programmname.java ausprobiert. Mit dem Ergebnis, dass ur viele HTMLs erstellt werden, aber es ist keins dabei, wo die Kommentare enthalten sind. :wein:

[WolfB]

Vielleicht sind die Kommentare fehlerhaft? Wie schauen sie denn aus?

[Maho]

Ich habe mal einfach zum Testen dies hier ausprobiert...


import java.util.*;

/*
*
* @author Bla bla
* @version 1.00 2007/10/22
*/

public class test {

public test() {
}

}

[Maho]

ok.. durch bisl mehr herumspielen, hab ich jetzt herausgefunden, wie es funktioniert.

[Paulchen]

Vielleicht interessiert jemanden in einiger Zeit auch mal, wie man Javadoc einsetzt. Der fängt mit deinem Posting aber nicht viel an. ;)

[fabb]

Mich würds zum Beispiel interessieren.
Also wie hast es jetzt hinbekommen?

thx
fabb

[killingspree]

import java.util.*;
/**
* some javadoc info for the class
* @author killingspree
* @version 0.01
*/
public class Test {

/**
* some javadoc info for the method
*/
public static void main(String args[]) {
// some none javadoc comment
}

/*
* also not javadoc
*/
}


danch
javadoc Test.java
ausführen

voilá ;)

anmerkung: der @author Tag wird per default nicht ins javadoc übernommen.

[Bobsch]

http://java.sun.com/j2se/javadoc/writingdoccomments/index.html

google bemühen, lesen (auch wenns englisch ist). zugegebenerweise, die beispiele sind teilweise beschissen, aber man kanns damit auf jeden fall lernen...

mfg,
flo

[WolfB]

Auch im Buch von Schiedermeier ist es gut erklärt (es gibt sogar eine eigenes Kapitel dazu)

[Bobsch]

ja, aber leider ist es beim schiedermeier unvollständig und nur mit ungenügenden bespielen. deshalb die sun-gschichte anschauen

[zool]

Hab auch eine weile gesucht, bin dann draufgekommen nicht die Art der Kommentrare im Programm selbst war der Fehler sondern, der javadoc-Aufruf selbst, so ist bei mir dann das rausgekommen was ich wollte:
javadoc -private -author -version AsciiReader.java

[Aster62]

Schreiben Sie Ihr Programm möglichst allgemein und kommentieren Sie es gut. Die Kommentare im Programm gelten als Dokumentation. Die Dokumentation Ihrer Programme wird ebenfalls beurteilt. Es ist erlaubt/erwünscht die Kommentare javadoc-konform zu erstellen.

Bin gerade noch ein bisschen verwirrt.
Das javadoc-tool generiert einige Dateien im Hauptverzeichnis,
wo sich auch die Calculator.java (in meinem Fall) befindet.

Großteils *.html Dateien. Sollen wir javadoc ausführen und die
komplette Dokumentation mitabgeben, oder sollen wir nur die
Calculator.java (oder eben ascii) archivieren und abschicken,
so dass die Dokumentation dann von dem Prüfer erstellt werden kann?

Freundliche Grüße,
Aster

[Paulchen]

Nur die .java-Dateien abgeben. Javadoc-konform heißt nur, dass die Kommentare dem entsprechen, was How to Write Doc Comments for the Javadoc Tool (http://java.sun.com/j2se/javadoc/writingdoccomments/) beschreibt.