Documentation de projet Maven

Dans cette section, nous allons principalement apprendre à créer un document de projet Maven.

Par exemple, nous sommes dans C :/Dans le répertoire MVN, le projet consumerBanking a été créé, 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

Modifier pom.xml, ajoutez la configuration suivante (si elle n'existe pas déjà) :

<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, lors de l'exécution de la commande mvn site, il apparaît java.lang.NoClassDefFoundError: org/apache/maven/doxia/siterenderer/DocumentContent maven Cela est dû à un problème avec-site-La version du plugin est trop ancienne, mettez-la à niveau vers 3.3+ C'est tout.

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

C:\MVN\consumerBanking> mvn site

Maven commence à générer des documents :

[INFO] Recherche de projets...
[INFO]　-------------------------------------------------------------------
[INFO] Construction de consumerBanking
[INFO] tâche-segment: [site]
[INFO]　-------------------------------------------------------------------
[INFO] [site:site {execution: default-site}]
[INFO] artefact org.apache.maven.skins:maven-default-skin:　
Vérification des mises à jour à partir du central
[INFO] Génération du rapport "À propos".
[INFO] Génération du rapport "Suivi des problèmes".
[INFO] Génération du rapport "Équipe du projet".
[INFO] Génération du rapport "Dépendances".
[INFO] Génération du rapport "Intégration continue".
[INFO] Génération du rapport "Dépôt source".
[INFO] Génération du rapport "Licence du projet".
[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]　-------------------------------------------------------------------

Ouvrir C:\MVN\consumerBanking\target\site Cliquez sur index.html Vous pouvez voir le document.

Maven utilise un nom DoxiaMoteur de traitement de document pour créer des documents, il peut lire des sources de divers formats dans un modèle de document universel. Pour rédiger la documentation de votre projet, vous pouvez écrire le contenu dans l'un des formats courants, qui peuvent être convertis par Doxia.