本教程将教您如何一次创建应用程序的文档.让我们开始吧,使用前面章节中给出的示例转到您创建java consumerBanking 应用程序的C:/MVN目录.打开 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在目标目录中创建了一个站点.
打开C:\ MVNN \ cosumerBanking\target \ site文件夹.点击index.html查看文档.
Maven使用名为 Doxia 的文档处理引擎创建文档将多种源格式读入通用文档模型.要为您的项目编写文档,您可以使用以下几种常用格式编写内容,这些格式由Doxia解析.
<! -->
格式名称 | 描述 | 参考 |
---|---|---|
APT | 纯文本文档格式 | https://maven.apache.org/doxia |
XDoc | Maven 1.x文档格式 | https://jakarta.apache.org/site |
FML | 用于常见问题文档 | https://maven.apache.org |