十一、Maven 工程文档

十一、Maven 工程文档

本教程将教你如何创建应用程序的文档。那么让我们开始吧,在 C:/ MVN 目录下,创建你的 java consumerBanking 应用程序。打开 consumerBanking 文件夹并执行以下 mvn 命令。

1
C:\MVN>mvn site

Maven 将开始构建工程。

打开 C:\MVN\consumerBanking\target\site 文件夹。点击 index.html 就可以看到文档了。

Maven 使用称作 Doxia 的文件处理引擎创建文档,它将多个源格式的文件转换为一个共通的文档模型。要编写工程文档,你可以使用以下能够被 Doxia 解析的几种常用格式来编写。

格式名称描述引用
XDocMaven 1.x 版本的文档格式http://jakarta.apache.org/site/jakarta-site2.html
FMLFAQ 文档格式http://maven.apache.org/doxia/references/fml-format.html
XHTML可扩展 HTML 格式http://en.wikipedia.org/wiki/XHTML