Maven-Projektdokumentation

In diesem Kapitel lernen wir, wie man Dokumentationen für Maven-Projekte erstellt.

Zum Beispiel auf C:/Im MVN-Verzeichnis wurde das Projekt consumerBanking erstellt, Maven verwendet den folgenden Befehl, um Java-Projekte schnell 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 folgenden Einstellungen hinzu (wenn 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>

sonst tritt beim Ausführen des Befehls mvn site auf java.lang.NoClassDefFoundError: org/apache/maven/doxia/siterenderer/DocumentContent zurückzuführen, Dies ist auf ein Problem von-site-Plugin-Version zu niedrig, auf Version 3.3+ Fertig.

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

C:\MVN\consumerBanking> mvn site

Maven beginnt mit der Erstellung von Dokumenten:

[INFO] Durchsuchen nach Projekten...
[INFO]　-------------------------------------------------------------------
[INFO] Erstellung von consumerBanking
[INFO] Aufgabe-Segment: [site]
[INFO]　-------------------------------------------------------------------
[INFO] [site:site {execution: default-site}]
[INFO] artefact org.apache.maven.skins:maven-Standard-Skin:　
Nach Updates aus dem Zentrum suchen
[INFO] Erzeugung des "Über"-Berichts.
[INFO] Erzeugung des "Issue Tracking"-Berichts.
[INFO] Erzeugung des "Projekt-Team"-Berichts.
[INFO] Erzeugung des "Abhängigkeiten"-Berichts.
[INFO] Erzeugung des "Continuous Integration"-Berichts.
[INFO] Erzeugung des "Quell-Repository"-Berichts.
[INFO] Erzeugung des "Projekt-Lizenz"-Berichts.
[INFO]　Erstellung des Berichts "Mailing-Listen".
[INFO]　Erstellung des Berichts "Plugin-Verwaltung".
[INFO]　Erstellung des Berichts "Projektübersicht".
[INFO]　-------------------------------------------------------------------
[INFO]　BUILD　ERFOLGREICH
[INFO]　-------------------------------------------------------------------
[INFO]　Gesamte　Zeit:　16　sekunden
[INFO]　Beendet　bei:　Wed　Jul　11　18:11:18　IST　2012
[INFO]　Endgültiges　Memory:　23M/148M
[INFO]　-------------------------------------------------------------------

Öffnen C:\MVN\consumerBanking\target\site Ordner. Klicken Sie auf index.html können Sie die Dokumente sehen.

Maven verwendet einen Namens DoxiaDokumentverarbeitungsmotor, um Dokumente zu erstellen, der verschiedene Formate von Quellcode in ein allgemeines Dokumentenmodell lesen kann. Um Dokumente für Ihr Projekt zu schreiben, können Sie Inhalte in eine der folgenden gebräuchlichen, von Doxia konvertierbaren Formate schreiben.