Документация проекта Maven

В этой главе мы будем изучать, как создавать документацию проекта Maven.

Например, если мы создали проект consumerBanking в директории C:/MVN, Maven использует следующую команду для быстрого создания java проекта:

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

Редактировать pom.xml, добавить следующую конфигурацию (если её ещё нет):

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

в противном случае при выполнении команды mvn site会出现 java.lang.NoClassDefFoundError: org/apache/maven/doxia/siterenderer/DocumentContent проблемы， Это　из-за　низкой　версии　maven-site-plugin，необходимо　обновить　до　3.3+.

Откройте папку consumerBanking и выполните следующую команду mvn.

C:\MVN\consumerBanking>　mvn　site

Maven　начинает　генерировать　документацию：

[INFO]　Сканирование　проектов...
[INFO]　-------------------------------------------------------------------
[INFO]　Сборка　consumerBanking
[INFO]task-segment:　[site]
[INFO]　-------------------------------------------------------------------
[INFO]　[site:site　{execution:　default-site}]
[INFO]　artifact　org.apache.maven.skins:maven-default-skin:　
проверка　обновлений　из　центрального
[INFO]　Генерация　отчёта　"О нас".
[INFO]　Генерация　отчёта　"Трекинг　вопросов".
[INFO]　Генерация　отчёта　"Команда　проекта".
[INFO]　Генерация　отчёта　"Зависимости".
[INFO]　Генерация　отчёта　"Непрерывная　интеграция".
[INFO]　Генерация　отчёта　"Хранилище　исходных　код".
[INFO]　Генерация　отчёта　"Лицензия　проекта".
[INFO]　Генерация　отчёта　"Списки　рассылки".
[INFO]　Генерация　отчёта　"Управление　дополнениями".
[INFO]　Генерация　отчёта　"Обзор　проекта".
[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]　-------------------------------------------------------------------

открыть C:\MVN\consumerBanking\target\site папка. Нажмите index.html и вы можете увидеть документ.

Maven использует имя DoxiaДокументообрабатывающий двигатель, который создает документ, он может читать исходные коды различных форматов в один通用ный модель документа. Чтобы написать документ для вашего проекта, вы можете написать содержимое в одном из следующих常用的 форматов, которые могут быть преобразованы Doxia.