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

Question

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

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

有些解决方案涉及向我的代码添加内容，例如@SuppressWarnings或像// CHECKSTYLE.OFF这样的注释，但这不会使我的代码更好，我只能添加javadoc。所以我正在寻找配置级别的解决方案。

Answer 1

  

我可以为具有特定注释的方法排除警告吗？

您可以使用一个特定的注释（@SuppressWarnings）来抑制警告，但其他注释不能用于此效果（例如@MyEvent）。

至少没有开箱即用。如果您愿意进行一些编程，您可以开发自己的custom filter来满足您的需求。

Answer 2

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>