无涯教程-Maven - 项目文档

60 阅读1分钟

本教程将教您如何一次性创建应用程序的文档。因此,让无涯教程开始吧,进入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已在目标目录中创建了一个站点。

documentation site pages

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

consumer web page

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

格式名称 说明 参考
APT 纯文本文档格式

https://maven.apache.org/doxia

XDoc Maven 1.x文档格式

https://jakarta.apache.org/site

FML 用于常见问题解答文件

https://maven.apache.org

参考链接

www.learnfk.com/maven/maven…