如何在 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 。