Maven项目可以通过​​maven-site-plugin​​插件生成项目文档，无论什么项目都可以生成。

执行命令：



mvn site


Maven生成项目文档_maven

生成完成的输出目录在${basedir}/target/site文件夹，直接点击index.html查看即可。

Maven生成项目文档_maven_02

Maven生成项目文档_html_03

原理解释：

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

格式名

描述

参考

Apt

纯文本文档格式

​​http://maven.apache.org/doxia/references/apt-format.html​​

Xdoc

Maven 1.x 的一种文档格式

​​http://jakarta.apache.org/site/jakarta-site2.html​​

FML

FAQ 文档适用

​​http://maven.apache.org/doxia/references/fml-format.html​​

XHTML

可扩展的 HTML 文档

​​http://en.wikipedia.org/wiki/XHTML​​

​