多模块Maven项目如何使用javadoc插件生成文档

时间  2020-03-21
标签 多模块 maven 项目 如何 使用 javadoc 插件 生成 文档 栏目 Maven 繁體版
原文   原文链接

版权声明：本文为博主原创文章，未经博主容许不得转载。html

 

目录(?)[+]java

 

需求

        最近要对一个项目结构以下的Maven项目生成JavaDoc文档。apache

                Project
                        |-- pom.xml
                        |-- Module1
                                |   `-- pom.xml
                        |-- Module2
                                |   `-- pom.xml
                        |-- Module3
                                |-- pom.xmlapi

        这个就须要用到本文将要提出的一个Maven插件：javadoc。maven

 

基本使用

        插件的基本配置很简单：spa

 

[html]  view plain copy 在CODE上查看代码片 派生到个人代码片
 
  1. <plugin>  
  2.     <groupId>org.apache.maven.plugins</groupId>  
  3.     <artifactId>maven-javadoc-plugin</artifactId>  
  4.     <version>2.9.1</version>  
  5. </plugin>  

        若是对于一个普通的Maven项目，那么这个配置就可让你输出一个JavaDoc文档了（使用javadoc:javadoc命令）。

 

 

多模块Maven项目

        而咱们如今是一个多模块的Maven项目，那么就须要一些额外的配置来完成此操做：.net

 

[html]  view plain copy 在CODE上查看代码片 派生到个人代码片
 
  1. <plugin>  
  2.     <groupId>org.apache.maven.plugins</groupId>  
  3.     <artifactId>maven-javadoc-plugin</artifactId>  
  4.     <version>2.9.1</version>  
  5.     <configuration>  
  6.         <aggregate>true</aggregate>  
  7.     </configuration>  
  8. </plugin>  

        就是一个aggregate设置为true，就可让你在父项目运行javadoc:javadoc的时候，就会将子模块的JavaDoc生成在父项目的target下，而且会将其整合成一个JavaDoc。

 

 

自定义标签

        如今问题来了：插件

        咱们的类中的方法注释以下code

 

[html]  view plain copy 在CODE上查看代码片 派生到个人代码片
 
  1. /**  
  2.  * @author     : 张三  
  3.  * @group      : group  
  4.  * @Date       : 2014-01-26 21:14:49  
  5.  * @Comments   : 页面所含操做增删改查的ejb接口  
  6.  * @Version    : 1.0.0  
  7.  */  
  8. public interface IOperationBean {  
  9.         /**  
  10.          * @MethodName  : getOperationByID  
  11.          * @Description : 根据Id得到页面所含操做  
  12.          * @param ID 页面所含操做ID  
  13.          */  
  14.          PageOperation getOperationByID(String ID);  
  15. }  

        而咱们在生成JavaDoc后，并无看到Description和MethodName这两个注解中对应的内容。也就致使了方法的说明不知去向了。

 

        通过实验，要想像jdk那样让方法的描述紧跟在方法名后面，是须要这样添加注释的：xml

 

[html]  view plain copy 在CODE上查看代码片 派生到个人代码片
 
  1. /**  
  2.  * 根据Id得到页面所含操做  
  3.  * @param ID 页面所含操做ID  
  4.  */  
  5.  PageOperation getOperationByID(String ID);  

        已经到了项目后期，如今再让你们去改这些有些说不过去，查了下官网，发现有自定义标签，正好解决的就是这样的问题。

 

        而此次问题的出现，仍是源于咱们对于JavaDoc生成不熟悉。

        废话很少说，直接看例子：

 

[html]  view plain copy 在CODE上查看代码片 派生到个人代码片
 
  1. <plugin>  
  2.     <groupId>org.apache.maven.plugins</groupId>  
  3.     <artifactId>maven-javadoc-plugin</artifactId>  
  4.     <version>2.9.1</version>  
  5.     <configuration>  
  6.         <aggregate>true</aggregate>  
  7.         <tags>  
  8.             <tag>  
  9.                 <name>Description</name>  
  10.                 <placement>a</placement>  
  11.                 <head>用途</head>  
  12.             </tag>  
  13.         </tags>  
  14.     </configuration>  
  15. </plugin>  

        说明：

 

        1.name为你Java代码中的注解的名字

        2. placement这个在官网上有8种，我也本身试了下，其实这个就是说你要把哪些（方法、字段、类）上面的注解放到JavaDoc中

        3.head，若是不写这个，用的就是name，若是写了，那么显示效果以下：

                

        这样，你就既能够定义本身的注释规范，又能够生成相应的JavaDoc文档了

自定义路径

        这个功能通常不会用到，只是顺便看了一下，就写下来吧。
        在这里须要叨念两句关于约定优于配置，在最初我用Maven的时候，就看到过这样的话，Maven目录能够不这样设置么？能够，你能够本身改。
        只能说咱们在大部分时候，是不须要改这个，但不意味着咱们在作的时候就能够把这个作死，这样于用户，于从此的维护来讲，都不是一个好的选择。
        两句叨念完了，如今来看怎么设置吧：
[html]  view plain copy 在CODE上查看代码片 派生到个人代码片
 
  1. <plugin>  
  2.     <groupId>org.apache.maven.plugins</groupId>  
  3.     <artifactId>maven-javadoc-plugin</artifactId>  
  4.     <version>2.9.1</version>  
  5.     <configuration>  
  6.         <reportOutputDirectory>../myoutput</reportOutputDirectory>  
  7.         <destDir>myapidocs</destDir>  
  8.     </configuration>  
  9. </plugin>  

        说明：
        1.reportOutputDirectory是说的路径
        2.destDir是说的目标文件夹
        
        到这里Maven多模块下使用javadoc插件生成JavaDoc文档过程当中遇到的问题就都解决了。
相关文章
相关标签/搜索
每日一句
    每一个你不满意的现在，都有一个你没有努力的曾经。
本站公众号
   欢迎关注本站公众号,获取更多信息
联系我们 最近搜索 最新文章 沪ICP备13005482号-10 MyBatis教程 SQL 教程 MySQL教程 Java 教程 Thymeleaf 教程 Hibernate教程 Spring教程 Redis教程