Documentação do Projeto Maven

Nesta seção, vamos aprender como criar documentos de projetos Maven.

Por exemplo, no C:/No diretório MVN, foi criado o projeto consumerBanking, o Maven usou o seguinte comando para criar rapidamente um projeto java:

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

Modifique o pom.xml, adicione a seguinte configuração (se ainda não tiver):

<project>
　　...
<build>
<pluginManagement>
　　　　<plugins>
　　　　　　　　<plugin
　　　　　　　　　　<groupId>org.apache.maven.plugins/groupId>
　　　　　　　　　　<artifactId>maven-site-<plugin/<artifactId>plugin
　　　　　　　　　　<versão>3.3</versão>
　　　　　　　　</plugin>
　　　　　　　　<plugin
　　　　　　　　　　<groupId>org.apache.maven.plugins/groupId>
　　　　　　　　　　<artifactId>maven-project-info-reports-<plugin/<artifactId>plugin
　　　　　　　　　　<versão>2.7</versão>
　　　　　　　　</plugin>
　　　　</plugins>
　　　　</pluginManagement>
</build>
　...
</project>

caso contrário, ao executar o comando mvn site java.lang.NoClassDefFoundError: org/apache/maven/doxia/siterenderer/DocumentContent maven Isso é devido ao problema de-site-versão do plugin过低，atualize para 3.3+ Fim.

Abra a pasta consumerBanking e execute o seguinte comando mvn.

C:\MVN\consumerBanking> mvn site

Maven começando a gerar documentos:

[INFO] Escaneando por projetos...
[INFO]　-------------------------------------------------------------------
[INFO] Construção de consumerBanking
[INFO] tarefa-segment: [site]
[INFO]　-------------------------------------------------------------------
[INFO] [site:site {execution: padrão-site}]
[INFO] artefato org.apache.maven.skins:maven-padrão-skin:　
verificando atualizações do central
[INFO] Gerando relatório "About".
[INFO] Gerando relatório "Issue Tracking".
[INFO] Gerando relatório "Project Team".
[INFO] Gerando relatório "Dependencies".
[INFO] Gerando relatório "Continuous Integration".
[INFO] Gerando relatório "Source Repository".
[INFO] Gerando relatório "Project License".
[INFO] Gerando relatório "Listas de Correio".
[INFO] Gerando relatório "Gestão de Plugin".
[INFO] Gerando relatório "Resumo do Projeto".
[INFO]　-------------------------------------------------------------------
[INFO] CONSTRUÇÃO COM SUCESSO
[INFO]　-------------------------------------------------------------------
[INFO] Tempo Total:　16　segundos
[INFO] Concluído em: Sex Jul　11　18:11:18　IST　2012
[INFO] Memória Final:　23M/148M
[INFO]　-------------------------------------------------------------------

abrir C:\MVN\consumerBanking\target\site pasta. Clique em index.html para ver os documentos.

O Maven usa um nome chamado Doxiado motor de processamento de documentos para criar documentos, que pode ler códigos-fonte de vários formatos em um modelo de documento genérico. Para escrever a documentação do seu projeto, você pode usar os seguintes formatos comuns, que podem ser convertidos pelo Doxia.