Maven-Projektdokumentation

In diesem Kapitel lernen wir hauptsächlich, wie man Maven-Projektdokumentation erstellt.

Zum Beispiel haben wir das Projekt consumerBanking im Verzeichnis C:/MVN erstellt. Maven verwendet den folgenden Befehl, um schnell ein Java-Projekt zu erstellen:

mvn archetype:generate -DgroupId=com.companyname.bank -DartifactId=consumerBanking -DarchetypeArtifactId=maven-archetype-quickstart -DinteractiveMode=false

Ändern Sie pom.xml und fügen Sie die folgende Konfiguration hinzu (falls noch nicht vorhanden):

<project> ... <build> <pluginManagement> <plugins> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-site-plugin</artifactId> <version>3.3</version> </plugin> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-project-info-reports-plugin</artifactId> <version>2.7</version> </plugin> </plugins> </pluginManagement> </build> ... </project>

Andernfalls erzeugt beim Ausführen von mvn siteder Befehljava.lang.NoClassDefFoundError: org/apache/maven/doxia/siterenderer/DocumentContentden folgenden Fehler. Das liegt daran, dass die Version des maven-site-plugin zu niedrig ist; aktualisieren Sie einfach auf 3.3+.

Öffnen Sie den Ordner consumerBanking und führen Sie den folgenden mvn-Befehl aus.

C:\MVN\consumerBanking> mvn site

Maven beginnt mit der Generierung der Dokumentation:

[INFO] Scanning for projects...
[INFO] -------------------------------------------------------------------
[INFO] Building consumerBanking
[INFO]task-segment: [site]
[INFO] -------------------------------------------------------------------
[INFO] [site:site {execution: default-site}]
[INFO] artifact org.apache.maven.skins:maven-default-skin: 
checking for updates from central
[INFO] Generating "About" report.
[INFO] Generating "Issue Tracking" report.
[INFO] Generating "Project Team" report.
[INFO] Generating "Dependencies" report.
[INFO] Generating "Continuous Integration" report.
[INFO] Generating "Source Repository" report.
[INFO] Generating "Project License" report.
[INFO] Generating "Mailing Lists" report.
[INFO] Generating "Plugin Management" report.
[INFO] Generating "Project Summary" report.
[INFO] -------------------------------------------------------------------
[INFO] BUILD SUCCESSFUL
[INFO] -------------------------------------------------------------------
[INFO] Total time: 16 seconds
[INFO] Finished at: Wed Jul 11 18:11:18 IST 2012
[INFO] Final Memory: 23M/148M
[INFO] -------------------------------------------------------------------

Öffnen SieC:\MVN\consumerBanking\target\siteden Ordner. Klicken Sie aufindex.htmlund Sie können die Dokumentation sehen.

Maven verwendet eine Dokumentenverarbeitungs-Engine namensDoxiaDoxia zum Erstellen von Dokumentation. Sie kann Quellcode in verschiedenen Formaten in ein gemeinsames Dokumentmodell einlesen. Um Dokumentation für Ihr Projekt zu schreiben, können Sie den Inhalt in den folgenden gängigen Formaten schreiben, die von Doxia konvertiert werden können.

Formatname	Beschreibung	Referenz
Apt	Nur-Text-Dokumentformat	http://maven.apache.org/doxia/references/apt-format.html
Xdoc	Ein Dokumentformat von Maven 1.x	http://jakarta.apache.org/site/jakarta-site2.html
FML	Geeignet für FAQ-Dokumente	http://maven.apache.org/doxia/references/fml-format.html
XHTML	Erweiterbares HTML-Dokument	http://en.wikipedia.org/wiki/XHTML

Weitere Erweiterungen