Maven 項目文檔

本章節我們主要學習如何創建 Maven 項目文檔。

比如我們在 C:/MVN 目錄下,創建了 consumerBanking 項目,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 使用一個名為 Doxia的文檔處理引擎來創建文檔,它能將多種格式的源碼讀取成一種通用的文檔模型。要為你的項目撰寫文檔,你可以將內容寫成下麵幾種常用的,可被 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