Maven项目文档

本教程将教你如何一次性创建应用程序的文档。因此,让我们开始,使用前面章节中给出的示例,转到C:\ MVN目录,您已经创建了您的Java consumerBanking 应用程序。打开 consumerBanking 文件夹并执行以下 mvn 命令。

C:\MVN>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]-----------------------------------------------

您的项目文档已准备就绪。Maven在目标目录中创建了一个站点。

Maven项目文档-IT猿网-图片-1

打开C:\ MVN \ consumerBanking \ target \ site文件夹。点击index.html查看文档。

Maven项目文档-IT猿网-图片-2

Maven使用称为Doxia的文档处理引擎创建文档,该引擎将多种源格式读入通用文档模型。要为您的项目编写文档,您可以使用由Doxia解析的以下几种常用格式编写内容。

格式名称 描述 参考
XDOC Maven 1.x文档格式 [https://jakarta.apache.org/site](https://jakarta.apache.org/site/jakarta- site2.html)
FML 用于FAQ文档 [https://maven.apache.org](https://maven.apache.org/doxia/references/fml- format.html)
为你推荐
Log4j教程
Log4j教程
log4j是一种用Java编写的可靠,快速和灵活的日志框架(API)
直达