栏目分类:
子分类:
返回
名师互学网用户登录
快速导航关闭
当前搜索
当前分类
子分类
实用工具
热门搜索
名师互学网 > IT > 面试经验 > 面试问答

如何禁用特定代码行的特定checkstyle规则?

面试问答 更新时间: 发布时间: IT归档 最新发布 模块sitemap 名妆网 法律咨询 聚返吧 英语巴士网 伯小乐 网商动力

如何禁用特定代码行的特定checkstyle规则?

在http://checkstyle.sourceforge.net/config_filters.html#SuppressionCommentFilter上检查supressionCommentFilter的使用。你需要将模块添加到你的checkstyle.xml中

<module name="SuppressionCommentFilter"/>

它是可配置的。因此,你可以在代码中添加注释以关闭checkstyle(在各个级别),然后通过在代码中使用注释再次将其重新打开。例如

//CHECKSTYLE:OFFpublic void someMethod(String arg1, String arg2, String arg3, String arg4) {//CHECKSTYLE:ON

甚至更好,请使用以下经过调整的版本:

<module name="SuppressionCommentFilter">    <property name="offCommentFormat" value="CHECKSTYLE.OFF: ([w|]+)"/>    <property name="onCommentFormat" value="CHECKSTYLE.ON: ([w|]+)"/>    <property name="checkFormat" value="$1"/></module>

它允许你关闭对特定代码行的特定检查:

//CHECKSTYLE.OFF: IllegalCatch - Much more readable than catching 7 exceptionscatch (Exception e)//CHECKSTYLE.ON: IllegalCatch

注意:你还必须添加

FileContentsHolder

<module name="FileContentsHolder"/>

也可以看看

<module name="SuppressionFilter">    <property name="file" value="docs/suppressions.xml"/></module>

在SuppressionFilter同一页面上的部分下,你可以关闭对模式匹配资源的单独检查。

因此,如果你在

checkstyle.xml
中:

<module name="ParameterNumber">   <property name="id" value="maxParameterNumber"/>   <property name="max" value="3"/>   <property name="tokens" value="METHOD_DEF"/></module>

你可以使用以下命令在抑制XML文件中将其关闭:

<suppress id="maxParameterNumber" files="YourCode.java"/>

现在,Checkstyle 5.7中可用的另一种方法是通过@SuppressWarningsjava注释抑制冲突。为此,你将需要在配置文件中添加两个新模块(

SuppressWarningsFilter
SuppressWarningsHolder
):

<module name="Checker">   ...   <module name="SuppressWarningsFilter" />   <module name="TreeWalker">       ...       <module name="SuppressWarningsHolder" />   </module></module> 

然后,在你的代码中,你可以执行以下操作:

@SuppressWarnings("checkstyle:methodlength")public void someLongMethod() throws Exception {

或者,对于多重抑制:

@SuppressWarnings({"checkstyle:executablestatementcount", "checkstyle:methodlength"})public void someLongMethod() throws Exception {

注意:

“ checkstyle:”
前缀是可选的(但建议使用)。根据文档,参数名称必须全部小写,但实践表明任何大小写都可行。



转载请注明:文章转载自 www.mshxw.com
本文地址:https://www.mshxw.com/it/411119.html
我们一直用心在做
关于我们 文章归档 网站地图 联系我们

版权所有 (c)2021-2022 MSHXW.COM

ICP备案号:晋ICP备2021003244-6号