Maven项目文档
2023-09-14 09:11:59 时间
本教程学习如何一步到位地创建应用程序的文档。因此现在开始我们进入到 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 目录,如下图所示:
打开 C:\MVN\consumerBanking\target\site 文件夹。点击 index.html 打开此文档,看到结果如下图所示:
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 |
相关文章
- Zsh(oh-my-zsh)的Maven自动提示插件(zsh-maven-complection)
- Maven的-pl -am -amd参数学习
- spring-boot-maven-plugin插件的作用
- 多模块Maven项目如何使用javadoc插件生成文档
- Maven常用插件配置和使用
- eclipse中导入maven项目:org.apache.maven.archiver.MavenArchiver.getManifest(org.apache.maven.project.Maven
- 如何关掉Eclipse里对于Maven下载包的校验值检查
- Maven自定义上传第三方包到3rd party(第三方无依赖jar和本地扩展类加入maven统一管理)
- apache-maven-3.8.4下载配置【解决JDK15与Maven-3.3.9低版本不匹配问题---mvn -v无法找到JAVA_HOME环境变量】
- 全网最全的Gitlab CI/CD自动化部署的介绍和教程,使用GitLab CI/CD自动化热部署SpringBoot或maven项目,GitLab CI/CD的Kubernetes集群的集成
- 解决Maven重复依赖问题(同一个jar包,多个版本)maven同一依赖多版本共存 maven处理mysql-connector-java多版本问题 解决无法将“mvn”项识别为xxx jarjar
- 【Android Gradle 插件】将自定义 Gradle 插件上传到自建 Maven 仓库 ② ( java 和 groovy 插件自带文档任务 | 自定义文档打包任务 | 生成文档包 )
- 【Android Gradle 插件】将自定义 Gradle 插件上传到自建 Maven 仓库 ① ( Maven 仓库上传源码上传源码设置 | 自定义源码打包任务 | 自定义文档打包任务 )
- 使用Maven编译项目遇到——“maven编码gbk的不可映射字符”解决办法
- 微服务下 Spring Boot Maven 工程依赖关系管理
- Jenkins自动触发构建maven多模块项目
- 002-maven简介、本地仓库、远程仓库、镜像地址、发布
- Maven小结
- Maven deploy报错:Failed to deploy artifacts: Could not transfer artifact from/to snapshots 401 Unauthorized
- Maven deploy 报错: Failed to execute goal org.apache.maven.plugins:maven-deploy-plugin:deploy (default-deploy) on project Failed to retrieve remote metadata /maven-metadata.xml
- windows下安装配置Maven
- Maven 项目文档
- 【异常】IDEA中Maven插件提示异常Failed to execute goal org.apache.maven.plugins:maven-surefire-plugin
- maven clean install命令报错 Failed to execute goal org.apache.maven.plugins:maven-clean-plugin