Maven項目文檔

本教程學習如何一步到位地創建應用程序的文檔。因此現在開始我們進入到  C:\MVN 創建 java 應用程序項目:consumerBanking。 進入到項目文件夾中執行以下命令 mvn 命令。 

C:\MVN>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 2015
[INFO] Final Memory: 23M/148M
[INFO] -------------------------------------------------------------------

完成後,在你的項目文件已構建完成。 Maven 會在 target 目錄中創建一個 site 目錄,如下圖所示:

documentation

打開 C:\MVN\consumerBanking\target\site 文件夾。點擊 index.html 打開此文檔,看到結果如下圖所示:

consumer

Maven會使用一個文件處理引擎: Doxia,它將會讀取多個源格式並將它們轉換爲通用文檔模型文檔。以下幾個是常用的格式使用來編寫項目文檔,這是由 Doxia 解析編寫內容。

格式名稱

描述

參考

APT

純文本文檔格式

http://maven.apache.org/doxia/format.html

XDoc

Maven1.x 的文檔格式

http://jakarta.apache.org/site/jakarta-site2.html

FML

用於常問問題(FQA)文件

http://maven.apache.org/doxia/references/fml-format.html

XHTML

可擴展HTML

http://en.wikipedia.org/wiki/XHTML