Maven項(xiàng)目文檔

本章節(jié)我們主要學(xué)習(xí)如何創(chuàng)建 Maven 項(xiàng)目文檔。

比如我們在 C:/MVN 目錄下，創(chuàng)建了 consumerBanking 項(xiàng)目，Maven 使用下面的命令來快速創(chuàng)建 java 項(xiàng)目：

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>

不然運(yùn)行 mvn site 命令時出現(xiàn) java.lang.NoClassDefFoundError: org/apache/maven/doxia/siterenderer/DocumentContent 的問題， 這是由于 maven-site-plugin 版本過低，升級到 3.3+ 即可。

打開 consumerBanking 文件夾并執(zhí)行以下 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 文件夾。點(diǎn)擊 index.html 就可以看到文檔了。

Maven 使用一個名為 Doxia的文檔處理引擎來創(chuàng)建文檔，它能將多種格式的源碼讀取成一種通用的文檔模型。要為你的項(xiàng)目撰寫文檔，你可以將內(nèi)容寫成下面幾種常用的，可被 Doxia 轉(zhuǎn)化的格式。