Über Javadoc hinausgehende Doku?

[TSH]

Hallo,

ich würde ein großes Projekt gerne so dokumentieren, dass man sich leicht einarbeiten kann. Also nicht nur der Sourcecode in Javadoc, sondern z.B. auch getailliert das Ant-File durchgehen, vielleicht auch schreiben, was Ant überhaupt ist. Ein paar UML-Diagramme usw.

Spontan fällt mir ein Wiki zusätzlich zum Javadoc ein. Gibt's da evtl. andere Ansätze? Ist ja bestimmt kein exotisches Problem, dass ich mir da ausgedacht habe.

 

[kama]

Hi,

schon mal http://antdoc.free.fr/ angeschaut?

Eventuell wäre Maven auch einen Blick wert, da kann man per mvn site eine vollständige Projekt Seite erstellen (auch Seiten mit Dokumentation erstellen).

MfG
Karl Heinz Marbaise

 

[TSH]

Danke. Ich hab mir neben Apache Forrest jetzt auch mal Maven angeschaut. Aber besonders viele Infos über Dokumentation mit Maven hab ich nicht gefunden.

Hat jemand Maven schon mal für diesen Zweck eingesetzt und kann über seine Erfahrung berichten?

 

[Gast]

Prinzipiell wäre sicher ein Fein/Fachkonzept auch nichts schlechtes. Also ein Konzept in dem du die theoretische Basis des ganzen erstmal genau festlegst und dokumentierst. Leider haben zu viele Projekte nur JavaDoc und Entwurf.

 

[kama]

Hallo,

mit Maven kann man recht gute Dokumentation zzgl. der JavaDoc + Code-Coverage usw. Reports erstellen.

Die Dokumentation in Maven geht z.B. via APT (http://maven.apache.org/guides/mini/guide-apt-format.html).

unter src/site/apt/ kann man dann Dateien ablegen und damit dann entsprechende das Dokumentation was man möchte.
Links zu der jeweiligen Seite kann man im Site-Description ablegen.

MfG
Karl Heinz Marbaise