Documentación del proyecto Maven

En este capítulo aprenderemos principalmente cómo crear la documentación del proyecto Maven.

Por ejemplo, si hemos creado el proyecto consumerBanking en el directorio C:/MVN, Maven utiliza el siguiente comando para crear rápidamente un proyecto Java:

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

Modifica pom.xml y añade la siguiente configuración (si no existe):

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

De lo contrario, al ejecutar mvn siteel comando, aparecejava.lang.NoClassDefFoundError: org/apache/maven/doxia/siterenderer/DocumentContentel problema. Esto se debe a que la versión de maven-site-plugin es demasiado baja; basta con actualizarla a 3.3+.

Abre la carpeta consumerBanking y ejecuta el siguiente comando mvn.

C:\MVN\consumerBanking> mvn site

Maven comienza a generar la documentación:

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

AbreC:\MVN\consumerBanking\target\sitela carpeta. Haz clic enindex.htmly ya podrás ver la documentación.

Maven utiliza un motor de procesamiento de documentos llamadoDoxiaDoxia para crear documentación. Puede leer código fuente en varios formatos y convertirlo en un modelo de documento común. Para redactar documentación para tu proyecto, puedes escribir el contenido en los siguientes formatos comunes, que pueden ser convertidos por Doxia.

Nombre del formato	Descripción	Referencia
Apt	Formato de documento de texto plano	http://maven.apache.org/doxia/references/apt-format.html
Xdoc	Un formato de documento de Maven 1.x	http://jakarta.apache.org/site/jakarta-site2.html
FML	Adecuado para documentación FAQ	http://maven.apache.org/doxia/references/fml-format.html
XHTML	Documento HTML extensible	http://en.wikipedia.org/wiki/XHTML

Otras extensiones