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

ОткройтеC:\MVN\consumerBanking\target\siteпапку. Щелкнитеindex.html, и вы увидите документацию.

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

Название форматаОписаниеСсылка
Apt Формат простого текстового документа http://maven.apache.org/doxia/references/apt-format.html
Xdoc Формат документа Maven 1.x http://jakarta.apache.org/site/jakarta-site2.html
FML Подходит для документов FAQ http://maven.apache.org/doxia/references/fml-format.html
XHTML Расширяемый HTML-документ http://en.wikipedia.org/wiki/XHTML
Другие расширения