maven 項(xiàng)目文檔

如何使用 maven 創(chuàng)建項(xiàng)目文檔呢？比如我們?cè)?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 命令時(shí)出現(xiàn) java.lang.noclassdeffounderror: org/apache/maven/doxia/siterenderer/documentcontent 的問題， 這是由于 maven-site-plugin 版本過低，升級(jí)到 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 使用一個(gè)名為 doxia的文檔處理引擎來創(chuàng)建文檔，它能將多種格式的源碼讀取成一種通用的文檔模型。要為你的項(xiàng)目撰寫文檔，你可以將內(nèi)容寫成下面幾種常用的，可被 doxia 轉(zhuǎn)化的格式。