如何忽略具有特定注释的方法的 checkstyle javadoc 警告

Question

当我有一个没有 javadoc 的公共方法时，Checkstyle 会发出警告，这很好！当我覆盖一个公共方法时，我没有收到警告，因为 javadoc 在该方法的父类中已经可用。

例如，现在我的方法有另一个注释@MyEvent。现在我确实收到了警告但不想要它，因为注释说得够多了。我可以排除带有特定注释的方法的警告吗？

有一些解决方案涉及在我的代码中添加类似@SuppressWarnings或注释之类的东西，// CHECKSTYLE.OFF但这并没有使我的代码更好，我可以改为添加 javadoc。所以我正在寻找配置级解决方案。

Answer 1

JavadocMethod 模块的 allowedAnnotations 属性定义了 javadoc 检查时跳过/忽略哪些带注释的方法。给定的示例使用 Checkstyle v8.8 。

<module name="Checker">
  <module name="TreeWalker">
    <module name="JavadocMethod">
      <property name="allowedAnnotations" value="Override, Test, Before, BeforeClass"/>
    </module>
  </module>
</module>