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

【问题标题】：How to Ignore checkstyle javadoc warning for a method with a specific annotation如何忽略带有特定注释的方法的 checkstyle javadoc 警告
【发布时间】：2014-11-25 00:47:03
【问题描述】：

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

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

有一些解决方案涉及在我的代码中添加东西，比如@SuppressWarnings 或像// CHECKSTYLE.OFF 这样的 cmets，但这不会让我的代码更好，我可以只添加 javadoc。所以我正在寻找配置级别的解决方案。

【问题讨论】：

标签： java annotations checkstyle

【解决方案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>

【讨论】：

【解决方案2】：

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

您可以通过使用一个特定注释 (@SuppressWarnings) 来抑制警告，但不能使用其他注释来实现该效果（例如 @MyEvent）。

至少不是开箱即用。如果你愿意做一些编程，你可以开发你自己的custom filter 来满足你的需要。

【讨论】：

然后编程。如果我决定这样做，我会在这里发布代码:) 谢谢！