maven 项目文档——迹忆客-ag捕鱼王app官网

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

比如我们在 /workspace/java 目录下创建consumerbanking项目。maven 使用下面的命令来快速创建 java 项目：

$ mvn archetype:generate -dgroupid=com.companyname.bank -dartifactid=consumerbanking -darchetypeartifactid=maven-archetype-quickstart -dinteractivemode=false

更新，/workspace/java/consumerbanking 文件夹中的 pom.xml 如下所示。

pom.xml

  4.0.0
  com.companyname.bank
  consumerbanking
  jar
  1.0-snapshot
  consumerbanking
  http://maven.apache.org
 ...
  
    
      
        org.apache.maven.plugins
        maven-site-plugin
        3.7
      
    
  
  
    
      
        org.apache.maven.plugins
        maven-project-info-reports-plugin
        2.9
      
    
  
  ...

进入 consumerbanking 文件夹并执行以下 mvn 命令。

$ mvn site

有时候运行 mvn site 命令时出现 java.lang.noclassdeffounderror: org/apache/maven/doxia/siterenderer/documentcontent 的问题， 这是由于 maven-site-plugin 版本过低，升级到 3.3 即可。

maven 开始生成文档：

命令执行成功之后，会在项目下生成如下的文档

打开 /workspace/java/consumerbanking/target/site 文件夹。点击 index.html 就可以看到文档了。

maven 使用一个名为 的文档处理引擎来创建文档，它能将多种格式的源码读取成一种通用的文档模型。要为你的项目撰写文档，你可以将内容写成下面几种常用的，可被 doxia 转化的格式。