Maven 项目文档

本章节我们主要学习如何创建 Maven 项目文档。

比如我们在 C:/MVN 目录下，创建了 consumerBanking 项目，Maven 使用下面的命令来快速创建 java 项目：

mvn archetype:generate -DgroupId=com.companyname.bank -DartifactId=consumerBanking -DarchetypeArtifactId=maven-archetype-quickstart -DinteractiveMode=false

修改 pom.xml，添加以下配置（如果没有的话）：

不然运行  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 转化的格式。