当我有一个没有 javadoc 的公共(public)方法时,Checkstyle 会发出警告,这很好!当我覆盖公共(public)方法时,我没有收到警告,因为 javadoc 已经在该方法的父类中可用。
现在我的方法有另一个注释,例如 @MyEvent
。现在我确实收到了警告,但不想要它,因为注释说明的已经足够了。我可以排除带有特定注释的方法的警告吗?
有一些解决方案涉及向我的代码添加内容,例如 @SuppressWarnings
或注释,例如 //CHECKSTYLE.OFF
但这不会使我的代码更好,我可以而只是添加 javadoc。所以我正在寻找配置级别的解决方案。
最佳答案
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>
关于java - 如何忽略具有特定注释的方法的 checkstyle javadoc 警告,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/26120003/