Java 如何抑制CheckStyle中的警告?
我正在使用Eclipse的CheckStyle插件 在99%的时间里,它能很好地发现我并不打算做的事情,但在我真正打算故意违反规则的1%时间里,我想让CheckStyle知道它不必担心标记警告 示例:缺少Javadoc注释规则。大多数情况下,我希望方法上有Javadoc注释。但是,可以使用以下方法:Java 如何抑制CheckStyle中的警告?,java,eclipse,checkstyle,Java,Eclipse,Checkstyle,我正在使用Eclipse的CheckStyle插件 在99%的时间里,它能很好地发现我并不打算做的事情,但在我真正打算故意违反规则的1%时间里,我想让CheckStyle知道它不必担心标记警告 示例:缺少Javadoc注释规则。大多数情况下,我希望方法上有Javadoc注释。但是,可以使用以下方法: public boolean isValid() { return valid; } 可能没有它也能过得去 是否有类似于@SuppressWarnings注释的内容可用于将特定的CheckSt
public boolean isValid() {
return valid;
}
可能没有它也能过得去
是否有类似于@SuppressWarnings
注释的内容可用于将特定的CheckStyle规则冲突标记为可接受?也许是某种特殊格式的评论?我不想禁用规则,我只想忽略一个特定的违规行为
(我意识到,在这种情况下,我可以只编写Javadoc注释,但在其他情况下,修复规则冲突并不是那么简单)。看起来相当乏味,但需要明确的XML配置才能忽略它。通过使用Eclipse或Netbeans的Checkstyle插件,您可能会找到一个GUI来实现这一点。我在Checkstyle页面上找到了一个示例
合成指向Checkstyle配置页面。略读一下,我发现SuppressWithNearbyCommentFilter
似乎很有希望,除非我误解了它的用途…PhiLho是对的-SuppressWithNearbyCommentFilter或SuppressionCommentFilter可能会有所帮助。我已配置SuppressionCommentFilter,添加注释“CHECKSTYLE:OFF”和“CHECKSTYLE:ON”将暂时禁用检查样式 我建议不要使用这种方法,因为引用的类中的后续更改会更改行号,从而导致维护噩梦。最好更改要捕获或不全局捕获的警告的设置,或者在注释上使用CHECKSTYLE:OFF/CHECKSTYLE:ON。您可以添加一个如何使用这些注释的示例吗?他们只是进入标准的单行注释,他们可以使用多行注释,或者混合和匹配关闭和打开注释的注释类型吗?啊,没关系,我找到了这个答案:
<?xml version="1.0"?>
<!DOCTYPE suppressions PUBLIC
"-//Puppy Crawl//DTD Suppressions 1.1//EN"
"http://www.puppycrawl.com/dtds/suppressions_1_1.dtd">
<suppressions>
<suppress checks="JavadocStyleCheck"
files="AbstractComplexityCheck.java"
lines="82,108-122"/>
<suppress checks="MagicNumberCheck"
files="JavadocStyleCheck.java"
lines="221"/>
</suppressions>