Javadoc für Packages oder ganze Projekte

[DStefan]

Hallo alle,

ich arbeite erst seit kurzem mit Java und beschäftige mich zurzeit mit den Möglichkeiten von javadoc.

Die Dokumentation von Quellcode verstehe ich, also Dateien, Klassen, Methoden usw. aber wie dokumentiert man übergeordnete Dinge, also Packages oder ein ganzes Projekt? Kann ich dazu überhaupt javadoc verwenden, und falls ja, wie stelle ich das an?

Ich verwende Eclipse und würde am liebsten einfach gesonderte Dateien anlegen, also z.B. eine Datei für jedes Package, das dieses beschreibt und eine (besser noch mehrere) für das gesamte Projekt.

Danke für eure Tipps.


Stefan.

 

[knoppers]

Nimm Maven. Maven hat die Möglichkeit dir Javadocs deines Programmes aus deinen Kommentaren zu erstellen und dies mit sehr wenig Aufwand. Dies wäre die einfachste Möglichkeit.

 

[Marco13]

Packages kann man einfach dokumentieren, indem man eine
package.html
mit ins source-verzeichnis des Packages legt. Die wird dann automatisch als Package-Beschreibung eingebunden.

Maven... Hm...

 

[Noctarius]

Alternativ zur package.html gibt es noch die package-info.java 🙂

Maven für einen Anfänger finde ich auch etwas suspekt.

 

[DStefan]

Danke für die Tipps!

Alternativ zur package.html gibt es noch die package-info.java 🙂
Maven für einen Anfänger finde ich auch etwas suspekt.

Hmmmm ja... Anfänger bin ich nicht gerade, bloß Java-Anfänger 🙂
Ich kenne durchaus ein paar Build-Tools, Maven allerdings nicht. Aber in wiefern könnte mir Maven beim Dokumentieren weiterhelfen?


Stefan.

 

[knoppers]

Maven bietet die Möglichkeit dir aus deinen Kommentaren, usw. die Javadocs zu generieren.
Natürlich bietet weitaus mehr als nur dies. Für mich ist Maven schon ein unentbehrlicher Zusatz in der Java Entwicklung. Aber hierzu muss man sich schon ein bisschen einarbeiten, dies lernt man nicht mal so auf die Schnelle.