• Maven项目文档


    本教程学习如何一步到位地创建应用程序的文档。因此现在开始我们进入到  C:MVN 创建 java 应用程序项目: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 2015
    [INFO] Final Memory: 23M/148M
    [INFO] -------------------------------------------------------------------
    

    完成后,在你的项目文件已构建完成。 Maven 会在 target  目录中创建一个 site 目录,如下图所示:

    documentation site pages

    打开 C:MVNconsumerBanking argetsite 文件夹。点击 index.html 打开此文档,看到结果如下图所示:

    consumer web  page

    Maven会使用一个文件处理引擎: Doxia,它将会读取多个源格式并将它们转换为通用文档模型文档。以下几个是常用的格式使用来编写项目文档,这是由 Doxia 解析编写内容。

    格式名称描述参考
    APT 纯文本文档格式 http://maven.apache.org/doxia/format.html
    XDoc Maven1.x 的文档格式 http://jakarta.apache.org/site/jakarta-site2.html
    FML 用于常问问题(FQA)文件 http://maven.apache.org/doxia/references/fml-format.html
    XHTML 可扩展HTML http://en.wikipedia.org/wiki/XHTML

  • 相关阅读:
    [Winform]Media Player com组件应用中遇到的问题
    [Winform]Media Player播放控制面板控制,单击事件截获
    [Winform]Media Player组件全屏播放的设置
    [EF]数据上下文该如何实例化?
    [Winform]在关闭程序后,托盘不会消失的问题
    咏南中间件跨平台解决方案
    硬件中间件
    BASE64使用场景
    DELPHI7 ADO二层升三层新增LINUX服务器方案
    NGINX心跳检测
  • 原文地址:https://www.cnblogs.com/borter/p/9605518.html
Copyright © 2020-2023  润新知