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

Question

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

现在我对我的方法有其他注释，例如@MyEvent。现在我确实得到了警告，但不想要它，因为注释足够了。我可以排除具有特定注释的方法的警告吗？

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

Answer 1

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

您可以通过使用一个特定的注解（@SuppressWarnings）禁止警告，但其他注释不能使用该效果（如@MyEvent）。

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