maven checkStyle跳过指定文件检查

checkStyle可以规范团队代码风格,但是如果代码引用了外部依赖,则很有可能外部依赖不符合我们的checkstyle,这个时候我们需要跳过对外部依赖的检查。

分两种情况,checkstyle版本8.1之前和之后。
可以在pom中确定现在使用的版本

<dependency>
     <groupId>com.puppycrawl.tools</groupId>
     <artifactId>checkstyle</artifactId>
     <version>8.14</version>
</dependency>

checkstyle 8.1之前

  1. 在checkstyle.xml的<module name="Checker">下,加入<module name="SuppressionCommentFilter"/>
    即:
<module name="Checker">
    ...
    <module name="SuppressionCommentFilter"/>
    ...
</module>
  1. 在<module name="TreeWalker">下加入<module name="FileContentsHolder"/>
    即:
<module name="TreeWalker">
    ...
    <module name="FileContentsHolder"/>
    ...
</module>

8.1之后

只需要在在“ TreeWalker”节点下添加

<module name="SuppressionCommentFilter"/>

设置好之后,使用如下注解来跳过指定部分的代码检查

// CHECKSTYLE:OFF

若想跳过整个文件的检查,则将注释放在代码第一行。
若只想跳过部分代码块检查则用如下注释将代码块包起来

// CHECKSTYLE:OFF
代码块
// CHECKSTYLE:ON
©著作权归作者所有,转载或内容合作请联系作者
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。