maven 生成javadoc常见-白红宇

maven 生成javadoc常见

阅读量：6226 次

发布时间：2019-06-21

本文共 1258 字，大约阅读时间需要 4 分钟。

1 乱码问题

2自定义标签

<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
<version>${maven_javadoc_version}</version>
<configuration>
<aggregate>true</aggregate>
<tags>
<tag>
<name>checkstyle</name>
<placement>a</placement>
<head>略过checkstyle规则</head>
</tag>
</tags>
</configuration>
<executions>
<execution>
<id>attach-javadoc</id>
<goals>
<goal>jar</goal>
</goals>
<phase>compile</phase>
</execution>
</executions>
</plugin>

属性说明

name 标签名

placement 标签适用的位置

head 前置提示

属性	说明
name	标签名
placement	标签适用的位置
head	前置提示

该三个参数和用使用generate javadoc 生成时，第三步添加自定义标签基本一致

其添加方式如下：

-tag Date:a:"生成日期"

-tag Desc:a:"功能描述"

3 忽略告警、错误

常见的如@return和后面没有描述等等

网上常见的配置如下：

<plugin>

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

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

<version>2.10.3</version>

<executions>

<execution>

<id>attach-javadocs</id>

<goals>

<goal>jar</goal>

</goals>

<configuration>

<additionalparam>-Xdoclint:none</additionalparam>

</configuration>

</execution>

</executions>

</plugin>

这种方式的缺点是只能使用老版本插件，新版的maven是不支持的。新版的配置如下


         
      
       org.apache.maven.plugins
          
      
       maven-javadoc-plugin
          
      
       3.0.1
          
              
       
        none