我刚刚将我的构建从Java 17升级到Java 21。在Maven中,我使用Maven Javadoc Plugin-Xlint:all
编译器选项将Javadoc设置为DocLint。
与Java类的典型情况一样,我有大量如下形式的getter:
/** @return foo. */
public Foo getFoo() {
return foo;
}
字符串
在Java 17中,Javadoc生成得很好。现在在Java 21中,我在我的大型代码库中得到了以下警告(大量警告!):warning: no main description
个
Javadoc现在似乎希望我这样做:
/**
* Returns foo.
* @return foo.
*/
public Foo getFoo() {
return foo;
}
型
我很难理解这个新警告的效用。我想在配置中在项目范围内抑制这个警告。
我相信我可以通过使用-Xdoclint all,-missing
禁用整个DocLint组,但这将抑制与缺少Javadoc相关的 * 所有 * 警告。如果我为了一个getter而完全离开Javadoc,我肯定希望得到警告!
**如果@return
仍然存在,我如何只抑制与缺少“主描述”相关的Javadoc DocLint警告?**或者,如果这是不可能的,我怎样才能最好地与Javadoc团队沟通,增加越来越多的不能单独抑制的空洞警告,(比如我)谁喜欢保持我们的API文档超级整洁,完全放弃使用linter?
虽然我知道有些人会完全关闭linter,但我宁愿更具体一些。
另请参阅我的单独(相关)问题Turn off Java 17 doclint missing comment warning only for enums in Maven Javadoc Plugin。
1条答案
按热度按时间tct7dpnv1#
似乎不太可能有这样的粒度。
正如你完美地陈述的消息和检查包括在21 https://github.com/openjdk/jdk/blob/jdk-21%2B35/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclint/resources/doclint.properties#L43
x1c 0d1x的数据
在回顾了实现新检查的更改后,没有任何迹象表明可以实现禁用检查的粒度(由于github无法显示如此大的差异,因此需要克隆)。
字符串
的
您可能能够联系团队和/或提交您的提案/PR或对此类更改的反馈,如https://mail.openjdk.org/mailman/listinfo/discuss中所述,有一个社区列表 * email protected(https://stackoverflow.com/cdn-cgi/l/email-protection) *,但您不太可能在短期内看到这方面的更改。