Documentación del proyecto de Maven

En esta sección, aprenderemos principalmente cómo crear documentos de proyectos Maven.

Por ejemplo, en C:/En el directorio MVN, se creó el proyecto consumerBanking, Maven utilizó 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

Modificar pom.xml, agregar la siguiente configuración (si no se ha hecho):

<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-proyecto-info-informes-plugin</<artifactId>
　　　　　　　　　　<version>2.7</version>
　　　　　　　　</plugin>
　　　　</plugins>
　　　　</pluginManagement>
</build>
　...
</project>

de lo contrario, al ejecutar el comando mvn site java.lang.NoClassDefFoundError: org/apache/maven/doxia/siterenderer/DocumentContent maven Esto se debe a un problema de-site-versión del plugin demasiado baja, actualice a 3.3+ Listo.

Abra la carpeta consumerBanking y ejecute el siguiente comando mvn.

C:\MVN\consumerBanking> mvn site

Maven comienza a generar documentos:

[INFO] Escaneando proyectos...
[INFO]　-------------------------------------------------------------------
[INFO] Construyendo consumerBanking
[INFO] tarea-segment: [site]
[INFO]　-------------------------------------------------------------------
[INFO] [site:site {execution: default-site}]
[INFO] artefacto org.apache.maven.skins:maven-default-skin:　
Revisión de actualizaciones desde central
[INFO] Estudio del "About" informe.
[INFO] Estudio del "Issue Tracking" informe.
[INFO] Estudio del "Project Team" informe.
[INFO] Estudio del "Dependencies" informe.
[INFO] Estudio del "Continuous Integration" informe.
[INFO] Estudio del "Source Repository" informe.
[INFO] Estudio del "Project License" informe.
[INFO]　Generating　"Mailing　Lists"　report.
[INFO]　Generating　"Plugin　Management"　report.
[INFO]　Generating　"Project　Summary"　report.
[INFO]　-------------------------------------------------------------------
[INFO]　BUILD　SUCCESSFUL
[INFO]　-------------------------------------------------------------------
[INFO]　Total　time:　16　segundos
[INFO]　Finished　at:　Wed　Jul　11　18:11:18　IST　2012
[INFO]　Final　Memory:　23M/148M
[INFO]　-------------------------------------------------------------------

abrir C:\MVN\consumerBanking\target\site carpeta. Haga clic en index.html para ver los documentos.

Maven utiliza un nombre llamado Doxiaun motor de procesamiento de documentos para crear documentos, que puede leer código fuente de varios formatos en un modelo de documento genérico. Para escribir la documentación de su proyecto, puede usar los siguientes formatos comunes que Doxia puede convertir.