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 转化的格式。