如何在Maven Javadoc Plugin中仅关闭Java 17枚举的缺省注释警告?
解决Maven Javadoc Plugin枚举值注释警告问题
方案一:通过Maven插件配置全局忽略枚举常量注释警告
在pom.xml中配置Maven Javadoc Plugin,通过additionalparam参数指定doclint规则,启用所有检查但排除枚举常量的缺失注释警告:
<build> <plugins> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-javadoc-plugin</artifactId> <version>3.4.1</version> <configuration> <!-- 启用所有doclint检查,仅排除枚举常量的缺失注释警告 --> <additionalparam>-Xdoclint:all,-missing/enumConstant</additionalparam> </configuration> </plugin> </plugins> </build>
这个配置会让Javadoc插件忽略所有枚举值的缺失注释警告,但保留对类、方法、字段等其他元素的缺省注释检查。
方案二:通过代码注释抑制特定枚举的警告
如果只想针对某个特定枚举忽略警告,不想影响全局枚举,可以给目标枚举添加@SuppressWarnings("javadoc")注解:
@SuppressWarnings("javadoc") public enum PredefinedType { ACTIVITY, SPORT, BAR, COMPANY, CAFE, HOTEL, RESTAURANT, CAUSE, SPORTS_LEAGUE, SPORTS_TEAM, BAND, GOVERNMENT, NON_PROFIT, SCHOOL, UNIVERSITY, ACTOR, ATHLETE, AUTHOR, DIRECTOR, MUSICIAN, POLITICIAN, PROFILE, PUBLIC_FIGURE, CITY, COUNTRY, LANDMARK, STATE_PROVINCE, ALBUM, BOOK, DRINK, FOOD, GAME, MOVIE, PRODUCT, SONG, TV_SHOW, ARTICLE, BLOG, WEBSITE }
该注解仅作用于当前枚举类,会抑制其中所有枚举值的缺失注释警告,其他类的缺省注释检查不受影响。
内容的提问来源于stack exchange,提问作者Garret Wilson
相关产品推荐
相关产品推荐

