Documentation de projet Maven

Dans ce chapitre, nous apprenons principalement comment créer la documentation d'un projet Maven.

Par exemple, nous avons créé le projet consumerBanking dans le répertoire C:/MVN. Maven utilise la commande suivante pour créer rapidement un projet Java :

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

Modifiez pom.xml et ajoutez la configuration suivante (si elle n'est pas déjà présente) :

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

Sinon, l'exécution de la commande mvn siteproduirajava.lang.NoClassDefFoundError: org/apache/maven/doxia/siterenderer/DocumentContentl'erreur suivante. Cela est dû au fait que la version de maven-site-plugin est trop ancienne ; mettez simplement à niveau vers 3.3+.

Ouvrez le dossier consumerBanking et exécutez la commande mvn suivante.

C:\MVN\consumerBanking> mvn site

Maven commence à générer la documentation :

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

Ouvrez le dossierC:\MVN\consumerBanking\target\site. Cliquez surindex.htmlet vous pouvez voir la documentation.

Maven utilise un moteur de traitement de documents appeléDoxiaDoxia pour créer de la documentation. Il peut lire du code source dans divers formats vers un modèle de document commun. Pour écrire de la documentation pour votre projet, vous pouvez écrire le contenu dans les formats courants suivants qui peuvent être convertis par Doxia.

Nom du formatDescriptionRéférence
Apt Format de document en texte brut http://maven.apache.org/doxia/references/apt-format.html
Xdoc Un format de document de Maven 1.x http://jakarta.apache.org/site/jakarta-site2.html
FML Adapté aux documents FAQ http://maven.apache.org/doxia/references/fml-format.html
XHTML Document HTML extensible http://en.wikipedia.org/wiki/XHTML
Autres extensions