Apache Maven 工程文檔

本教程將教你如何創(chuàng)建應(yīng)用程序的文檔。那么讓我們開始吧。

在 C:/ MVN 目錄下，創(chuàng)建你的 java consumerBanking 應(yīng)用程序。打開 consumerBanking 文件夾并執(zhí)行以下 mvn 命令。

C:\MVN>mvn site

Maven 將開始構(gòu)建工程。

[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 文件夾。點(diǎn)擊 index.html 就可以看到文檔了。

Maven 使用稱作 Doxia 的文件處理引擎創(chuàng)建文檔，它將多個(gè)源格式的文件轉(zhuǎn)換為一個(gè)共通的文檔模型。要編寫工程文檔，你可以使用以下能夠被 Doxia 解析的幾種常用格式來編寫。