Maven - Documents du projet

Ce tutoriel vous apprendra comment créer la documentation de l'application en une seule fois. Alors commençons, allez dans le répertoire C: / MVN où vous aviez créé votre javaconsumerBankingapplication en utilisant les exemples donnés dans les chapitres précédents. OuvertconsumerBanking dossier et exécutez ce qui suit mvn commander.

C:\MVN>mvn site

Maven commencera à construire le projet.

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

La documentation de votre projet est maintenant prête. Maven a créé un site dans le répertoire cible.

Ouvrez le dossier C: \ MVN \ consumerBanking \ target \ site. Cliquez sur index.html pour voir la documentation.

Maven crée la documentation à l'aide d'un moteur de traitement de la documentation appelé Doxia qui lit plusieurs formats source dans un modèle de document commun. Pour rédiger la documentation de votre projet, vous pouvez rédiger votre contenu dans les quelques formats couramment utilisés suivants qui sont analysés par Doxia.

Nom du format	La description	Référence
XDoc	Un format de documentation Maven 1.x	https://jakarta.apache.org/site
FML	Utilisé pour les documents FAQ	https://maven.apache.org