maven 生成javadoc常见

最新推荐文章于 2025-06-26 21:34:21 发布

weixin_33834910

最新推荐文章于 2025-06-26 21:34:21 发布

阅读量748

点赞数 1

CC 4.0 BY-SA版权

文章标签： java

原文链接：https://my.oschina.net/mingziyaoxiangliang/blog/3038556

本文详细介绍了如何使用Maven Javadoc插件解决乱码问题，自定义标签，以及如何配置插件来忽略某些警告和错误，适用于Java开发者和Maven用户。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

2019独角兽企业重金招聘Python工程师标准>>>

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和@param 后面没有描述等等

网上常见的配置如下：

<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是不支持的。新版的配置如下

<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-javadoc-plugin</artifactId>
    <version>3.0.1</version>
    <configuration>
        <doclint>none</doclint>
    </configuration>
</plugin>

转载于:https://my.oschina.net/mingziyaoxiangliang/blog/3038556