0
点赞
收藏
分享

微信扫一扫

checkstyle教程:配置suppressions以忽略指定的目录


checkstyle.xml

<?xml version="1.0"?>
<!DOCTYPE module PUBLIC
    "-//Puppy Crawl//DTD Check Configuration 1.3//EN"
    "http://www.puppycrawl.com/dtds/configuration_1_3.dtd">

<module name="Checker">
    <property name="charset" value="UTF-8"/>
    <module name="SuppressionFilter">
            <property name="file" value="/home/zxl/suppressions.xml"/>
    </module>
    <!-- 每个java文件一个语法树 -->
    <module name="TreeWalker">
		<!-- 检查没有import语句使用*符号。 -->
		<module name="AvoidStarImport"/>
		<!-- 检查没有静态导入语句。 -->
		<module name="AvoidStaticImport"/>
		<!-- switch语句中的default是否在所有的case分支之后 -->
		<module name="DefaultComesLast" />
        <!-- 检查是否有空代码块 -->
        <module name="EmptyBlock"/>
		<!-- 检查空的Catch块 -->
		<module name="EmptyCatchBlock" />
        <!-- 检查空的代码段 -->
        <module name="EmptyStatement"/>
		<!-- 检查switch语句中是否存在跨越分支。 -->
		<module name="FallThrough" />
        <!-- 检查switch语句是否有default -->
        <module name="MissingSwitchDefault"/>
        <!-- 没用的import检查,比如:1.没有被用到2.重复的3.import java.lang的4.import 与该类在同一个package的 -->
        <module name="UnusedImports" />
        <!-- 检查未被注释的main方法 -->
        <module name="UncommentedMain">
            <property name="excludedClasses" value=".*[Application]$"/>
        </module>
        <!-- 检查是否导入了多余的包 -->
        <module name="RedundantImport"/>
        <!-- 检查左大括号位置 -->
        <module name="LeftCurly"/>
        <!-- 检查右大括号位置 -->
        <module name="RightCurly"/>
		
        <!-- String的比较不能用!= 和 == -->
        <module name="StringLiteralEquality"/>
		<!-- 确保 注解@Deprecated 和 Javadoc tag @deprecated 同时存在-->
		<module name="MissingDeprecated" />
		<!-- 当出现  Javadoc tag @inheritDoc 时候, 确保 注解@Override 同时存在 ; 测试未发现生效; 欢迎反馈 ~LQ -->
		<module name="MissingOverride" />
    </module>
</module>

suppressions.xml

/home/zxl/suppressions.xml

<?xml version="1.0"?>

<!DOCTYPE suppressions PUBLIC
        "-//Checkstyle//DTD SuppressionFilter Configuration 1.2//EN"
        "https://checkstyle.org/dtds/suppressions_1_2.dtd">

<suppressions>
    <suppress files="^(?!.*\/cloud-platform\/).*" checks="[a-zA-Z0-9]*"/>
</suppressions>


举报

相关推荐

0 条评论