`
zjx2388
  • 浏览: 1334259 次
  • 性别: Icon_minigender_2
  • 来自: 北京
社区版块
存档分类
最新评论

maven工程生成javadoc api

 
阅读更多
  1. Checkout 所有代码到本地目录

  2. 修改工程的pom.xml,加入两段配置,具体如下



      

    <plugin>

    <groupId>org.apache.maven.plugins</groupId>

    <artifactId>maven-javadoc-plugin</artifactId>

    <version>2.9.1</version>

    <configuration>

    <reportOutputDirectory>../javadocs</reportOutputDirectory>

    <destDir>easy-delivery</destDir>

    </configuration>

    </plugin>

     

    <profile>

     <properties>

    <maven.compiler.encoding>UTF-8</maven.compiler.encoding>

    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>

     </properties>

    </profile>

     

  3. Cmd进入工程下trunk目录(即在pom.xml的目录)(快捷操作:进入目录,shift+ 鼠标右键,会出现一个‘在此处打开命令窗口(w)’,选中即可),执行 mvn javadoc:javadoc命令



      

     

  4. 出现build success,javadoc生成完成




     
      

  5. 执行结束后,进入项目根目录,可查看javadoc

     

     

     

 

  • 大小: 44.7 KB
  • 大小: 25.6 KB
  • 大小: 54.7 KB
  • 大小: 28.4 KB
  • 大小: 20.6 KB
  • 大小: 50.3 KB
分享到:
评论

相关推荐

    maven-javadoc-plugin 中文 注释 API 解决乱码 pom xml

    在默认情况下,`maven-javadoc-plugin`插件在生成Javadoc文档时采用的是ISO-8859-1编码格式,这种编码方式无法正确解析中文字符,从而导致中文乱码现象。 ##### 2.2 解决方案 - **POM文件配置** 在`pom.xml`文件...

    maven-javadoc-plugin-2.7.rar_maven

    总的来说,Maven提供了一种统一的方式来管理Java项目的构建过程,而`maven-javadoc-plugin`则进一步增强了这一能力,通过自动生成Javadoc文档,帮助开发者更好地理解和使用项目API。通过熟练掌握Maven和它的插件,...

    本项目是IntelliJ IDEA的插件,能帮助java开发者自动生成javadoc文档注释

    Easy Javadoc插件的核心功能在于自动生成Javadoc文档注释。通常,手动编写Javadoc注释可能需要开发者花费大量时间,而这个插件通过解析代码结构和内容,能够快速地生成符合Javadoc规范的注释模板。这不仅提高了工作...

    Maven在Java8下如何忽略Javadoc的编译错误详解

    在Java开发中,JavaDoc是一种重要的工具,它能够自动生成项目的API文档,提供类、方法、接口等的详细说明。然而,在使用Java8时,Maven的JavaDoc插件(maven-javadoc-plugin)对JavaDoc的语法检查变得更加严格,有时...

    javadoc2swagger:将Javadoc转换为-读取自定义javadoc标记并生成一个swagger文件

    这个Maven插件正在为基于JAX-RS的Java服务器生成Swagger API文档。 JAX-RS批注中未包含的其他信息放置在Javadoc注释中。 例 此处提供了一个使用javadoc2swagger-maven-plugin示例Maven项目: 介绍 从Java源代码创建...

    新建maven工程包含源码和文档

    5. **配置文档**: Maven支持自动生成API文档,通常使用Javadoc插件。在`pom.xml`中添加以下配置: ```xml &lt;groupId&gt;org.apache.maven.plugins &lt;artifactId&gt;maven-javadoc-plugin &lt;version&gt;3.3.0 &lt;id&gt;...

    Maven3实战笔记14Maven生成项目站点

    例如,添加 `maven-javadoc-plugin` 生成 API 文档,或 `maven-project-info-reports-plugin` 生成项目信息报告。 6. **部署站点**:生成的站点默认位于 `target/site` 目录下,可以通过 `mvn site:deploy` 命令将...

    javadoc插件使用文档

    首先,需要在pom.xml文件中添加javadoc插件的配置信息,然后执行Maven build命令生成javadoc文件。 * 如何使用javadoc文件? javadoc文件可以用于查看项目的API文档,可以打开allclasses-frame.html文件查看项目的...

    apacheds-maven-plugin-0.1-javadoc.jar.zip

    这个插件的主要功能是帮助开发者在Maven项目中集成ApacheDS的相关操作,例如生成Javadoc文档,以便更好地理解和使用ApacheDS的API。 Maven是一个强大的Java项目管理和集成工具,它通过使用一个项目对象模型...

    Apache Maven插件

    5. 执行命令:通过命令行执行Maven命令,如`mvn javadoc:jar`,Maven会生成Javadoc并将其打包进JAR文件。 四、插件生态系统 Maven拥有庞大的插件生态系统,涵盖了各种功能,如Spring Boot插件、Tomcat插件、JaCoCo...

    apache-maven-3.5.4.zip

    8. **报表生成**: Maven 可以生成各种类型的项目报告,如Javadoc、单元测试结果、代码覆盖率等,帮助开发者了解项目的质量状况。 9. **Maven Archetypes**: Maven Archetypes 是预定义的项目模板,可以帮助开发者...

    apache-maven下载

    通过安装和配置各种插件,Maven可以执行诸如编译、测试、打包、部署等多种构建任务,甚至包括生成Javadoc、源码包,以及创建项目报告等。例如,maven-surefire-plugin用于执行单元测试,maven-javadoc-plugin用于...

    maven plugin maven plugin

    通过配置 `maven-site-plugin` 可以创建项目的网站和文档,`maven-javadoc-plugin` 用于生成 API 文档,`maven-deploy-plugin` 则负责将构建好的工件部署到远程仓库。 Ant 是一个广泛使用的构建工具,它具有灵活性...

    apache-maven-3.8.4-bin.zip maven下载鬼慢

    Maven还支持插件机制,允许扩展其功能,例如,你可以使用maven-javadoc-plugin生成API文档,maven-surefire-plugin执行单元测试,或者maven-site-plugin生成项目网站。在pom.xml中定义插件及其配置,即可实现这些...

    maven生成web项目时pom配置

    10. **报告集(Reporting)**:定义Maven生成的项目报告,如Javadoc和测试覆盖率报告。 ```xml &lt;groupId&gt;org.apache.maven.plugins &lt;artifactId&gt;maven-javadoc-plugin &lt;version&gt;3.3.0 &lt;!-- 其他报告插件...

    apache-maven-3.6.0.rar

    Maven的插件系统允许扩展其功能,如使用maven-javadoc-plugin生成API文档,maven-surefire-plugin运行测试,或者maven-deploy-plugin将项目部署到远程服务器。 总之,Apache Maven 3.6.0是Java开发中不可或缺的工具...

    java maven

    10. **文档生成**:Maven可以通过javadoc插件自动生成API文档,通过site插件生成项目报告,提高项目的可读性和维护性。 在实际开发中,掌握Maven的使用能够极大地提高开发效率,减少重复劳动,同时也有利于团队协作...

    maven-3.3.9.zip

    Maven拥有丰富的插件库,可以扩展其功能,如`maven-surefire-plugin`用于执行单元测试,`maven-javadoc-plugin`生成API文档,`maven-site-plugin`生成项目站点等。 ### 9. 依赖管理 在大型项目中,依赖管理至关重要...

    maven安装包

    4. **插件使用**:Maven 插件丰富,如使用 `maven-surefire-plugin` 运行测试,`maven-assembly-plugin` 创建自定义打包,`maven-javadoc-plugin` 生成 API 文档等。 5. **生命周期与构建阶段**:Maven 有三个主要...

    maven pdf

    3. **Maven Reports Plugin**: Maven 提供了一系列内置的报告插件,例如 Javadoc、PMD、Checkstyle 等,这些插件可以生成 PDF 格式的项目报告。通过配置 `maven-site-plugin` 和 `maven-project-info-reports-plugin...

Global site tag (gtag.js) - Google Analytics