Documentazione del progetto Maven

本章节我们主要学习如何创建 Maven 项目文档。

比如我们在 C:/MVN 目录下，创建了 consumerBanking 项目，Maven 使用下面的命令来快速创建 java 项目：

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

修改 pom.xml，添加以下配置（如果没有的话）：

<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>

Altrimenti, durante l'esecuzione del comando mvn site si verifica java.lang.NoClassDefFoundError: org/apache/maven/doxia/siterenderer/DocumentContent Il problema è: Questo è dovuto alla versione过低 del plugin maven-site, aggiornala a 3.3+.

Apri la cartella consumerBanking e esegui il seguente comando mvn.

C:\MVN\consumerBanking> mvn site

Maven inizia a generare la documentazione:

[INFO] Ricerca di progetti...
[INFO]　-------------------------------------------------------------------
[INFO] Costruzione di consumerBanking
[INFO] segmento-lavoro: [sito]
[INFO]　-------------------------------------------------------------------
[INFO] [sito:sito {esecuzione: default-site}]
[INFO] artefatto org.apache.maven.skins:maven-default-skin:　
Controllo degli aggiornamenti dal centrale
[INFO] Generazione del rapporto "Informazioni".
[INFO] Generazione del rapporto "Tracciamento Problemi".
[INFO] Generazione del rapporto "Team Progetto".
[INFO] Generazione del rapporto "Dipendenze".
[INFO] Generazione del rapporto "Integrazione Continua".
[INFO] Generazione del rapporto "Repository Sorgente".
[INFO] Generazione del rapporto "Licenza Progetto".
[INFO] Generazione del rapporto "Liste di Posta".
[INFO] Generazione del rapporto "Gestione Plugin".
[INFO] Generazione del rapporto "Riepilogo Progetto".
[INFO]　-------------------------------------------------------------------
[INFO]　COSTRUIRE CON SUCCESSO
[INFO]　-------------------------------------------------------------------
[INFO]　Tempo totale:　16 secondi
[INFO]　Terminato il:　Mer 11 Lug 18:11:18 IST 2012
[INFO]　Memoria finale:　23M/148M
[INFO]　-------------------------------------------------------------------

aprire C:\MVN\consumerBanking\target\site Clicca su index.html puoi vedere i documenti.

Maven utilizza un nome chiamato DoxiaIl motore di elaborazione dei documenti per creare documenti, che può leggere sorgenti di vari formati in un modello di documento universale. Per scrivere la documentazione del tuo progetto, puoi scrivere il contenuto nei seguenti formati comuni, convertibili da Doxia.