本章节主要学习如何创建 Ma ven 项目文档。

比如我们在 C:/MVN 目录下，创建了 consumerBanking 项目。

Ma ven 使用下面的命令来快速创建 ja va 项目：

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

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

  ...


    
        
          org.apache.ma ven.plugins
          ma ven-site-plugin
          3.3
        
        
          org.apache.ma ven.plugins
          ma ven-project-info-reports-plugin
          2.7
        
    
    

 ...

否则在执行mvn site时，很容易报出 ja va.lang.NoClassDefFoundError: org/apache/ma ven/doxia/siterenderer/DocumentContent 这类错误。根源通常不复杂，就是 ma ven-site-plugin 的版本太旧了，把它升级到 3.3+，问题一般就能解决。

打开 consumerBanking 文件夹，并执行以下 mvn 命令。

C:MVNconsumerBanking> mvn site

Ma ven 开始生成文档：

[INFO] Scanning for projects...
[INFO] -------------------------------------------------------------------
[INFO] Building consumerBanking
[INFO]task-segment: [site]
[INFO] -------------------------------------------------------------------
[INFO] [site:site {execution: default-site}]
[INFO] artifact org.apache.ma ven.skins:ma ven-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:MVNconsumerBankingtargetsite 文件夹。点击 index.html 就可以看到文档了。

文档生成原理

Ma ven 使用一个名为 Doxia 的文档处理引擎来创建文档。

它能将多种格式的源码读取成一种通用的文档模型。

要为你的项目撰写文档，你可以将内容写成下面几种常用的、可被 Doxia 转化的格式。

《夸克》非常好用的免费AI浏览器

下载APP查看