如何在 Javadoc 中禁用特定类型的缺少注释警告？

Question

我通过 Gradle 使用 javadoc，自从升级到 Java 18 以来，javadoc 报告以下警告：

warning: use of default constructor, which does not provide a comment

我希望禁用此警告消息，以便我可以通过查看报告的警告数量来检查项目中 javadoc 注释的完整性。一般来说，可以使用-Xdoclint:all,-missing参数禁用缺少的文档注释，但这太粗略了，因为根据我的理解，它会禁用所有缺少注释的警告。关于默认构造函数缺少注释的警告对我来说并不有趣或没有帮助，因此我想专门禁用它们。

更多信息：JDK 提交引入了对默认构造函数缺少注释的检查，指定了缺少类型，dc.default.constructor但我还没有找到使用它的方法。

Answer 1

不幸的是，这是不可能的。 -Xdoclint 只提供missing密钥，没有更细粒度的控制。

如果您想要更细粒度的控制，可以使用require-javadoc程序而不是-Xdoclint:missing. require-javadoc 从不要求对默认构造函数进行注释，默认构造函数不会出现在源代码中。其配置包括以下命令行选项：

  --exclude=<regex>                - Don't check files or directories whose pathname matches the regex
  --dont-require=<regex>           - Don't report problems in Java elements whose name matches the regex
  --dont-require-private=<boolean> - Don't report problems in elements with private access [default: false]
  --dont-require-noarg-constructor=<boolean> - Don't report problems in constructors with zero formal params [default: false]
  --dont-require-trivial-properties=<boolean> - Don't report problems about trivial getters and setters [default: false]
  --dont-require-type=<boolean>    - Don't report problems in type declarations [default: false]
  --dont-require-field=<boolean>   - Don't report problems in fields [default: false]
  --dont-require-method=<boolean>  - Don't report problems in methods and constructors [default: false]
  --require-package-info=<boolean> - Require package-info.java file to exist [default: false]
  --relative=<boolean>             - Report relative rather than absolute filenames [default: false]
  --verbose=<boolean>              - Print diagnostic information [default: false]

但请注意，require-javadoc 永远不会警告缺少 Javadoc 标记，例如@param和@return。