checkstyle配置文件说明

来源：互联网发布：韩国的文化知乎编辑：程序博客网时间：2024/05/01 11:20

checkstyle配置文件说明（checkstyle 3.5）

属性说明basedir代码所在的位置AbstractClassNameformat: 定义抽象类的命名规则PackageNameformat: 定义包名的命名规则TypeNameformat: 定义类和接口的命名规则
tokens: 定义规则适用的类型，例如：CLASS_DEF表示类，INTERFACE_DEF 表示接口ParameterNameformat: 定义参数名的命名规则ParameterNumbermax: 定义最多有多少个参数
tokens: 定义检查的类型StaticVariableNameformat: 定义静态变量的命名规则MethodNameformat: 定义方法名的命名规则LeftCurlyoption: 定义左大括号'{'显示位置，eol在同一行显示，nl在下一行显示
maxLineLength: 大括号'{'所在行行最多容纳的字符数
tokens: 该属性适用的类型，例：CLASS_DEF,INTERFACE_DEF,METHOD_DEF,CTOR_DEFLineLengthmax: 定义一行所能容许的字符数
ignorePattern: 定义可以忽略的格式MethodLength检查方法的行数
max: 最多容许的行数
countEmpty: 是否计算空行
tokens: 定义检查的类型RightCurlyoption: 右大括号是否单独一行显示
tokens: 定义检查的类型PackageHtml检查对每一个包是否生成了package.html文件
fileExtensions: 指定要检查的文件的类型，如果只包含java文件，就不必指定JavadocType检查类或者接口的javadoc注释
authorFormat: 检查author标签的格式
versionFormat: 检查version标签的格式
scope: 可以检查的类的范围，例如：public只能检查public修饰的类，private可以检查所有的类
excludeScope: 不能检查的类的范围，例如：public，public的类将不被检查，但访问权限小于public的类仍然会检查，其他的权限以此类推
tokens: 该属性适用的类型，例如：CLASS_DEF,INTERFACE_DEFJavadocMethod检查方法的javadoc的注释
scope: 可以检查的方法的范围，例如：public只能检查public修饰的方法，private可以检查所有的方法
allowMissingParamTags: 是否忽略对参数注释的检查
allowMissingThrowsTags: 是否忽略对throws注释的检查
allowMissingReturnTag: 是否忽略对return注释的检查JavadocVariable检查类变量的注释
scope: 检查变量的范围，例如：public只能检查public修饰的变量，private可以检查所有的变量JavadocStylescope:
excludeScope:
checkFirstSentence:
checkEmptyJavadoc:
checkHtml:
tokens:LocalVariableNameformat: 定义局部变量的命名规则LocalFinalVariableNameformat: 定义局部常量的命名规则ConstantNameformat: 定义全局常量的命名规则MemberNameformat: 定义非静态成员变量的命名规则
applyToPublic: 是否适用于public的成员变量
applyToProtected: 是否适用于protected的成员变量
applyToPackage: 是否适用于package的成员变量
applyToPrivate: 是否适用于private的成员变量AvoidStarImport必须导入类的完整路径，即不能使用*导入所需的类
excludes: 定义可以使用*导入的包ImportOrder定义导入包的顺序
groups: 定义导入包的顺序，默认以字母顺序导入
ordered: 定义包是否必须按规定的顺序显示
separated: 定义包与包之间是否应添加空白行
caseSensitive: 是否区分包名的大小写IllegalImport检查是否从非法的包中导入了类
illegalPkgs: 定义非法的包名称UnusedImports检查是否导入的包没有使用RedundantImport检查是否导入了不必显示导入的类EmptyForInitializerPad检查for语句初始化变量的格式
option: 定义初始化语句中是否使用空格，例如：space表示使用空格，则for(int i = 0; i < 100; i++)就是符合格式要求的，而for(int i=0; i<100;i++)就不符合要求EmptyForIteratorPad检查for iterator语句是否使用空格
option: 定义初始化语句是否使用空格，例如：space表示使用空格，则for(Iterator iterator = List.iterator(); iterator.hasNext(); iterator.next())就是形式合理的，否则就是形式不合理的ExecutableStatementCount检查要执行的语句的数目
max: 定义所能容许的语句的最多数目
tokens: 定义可以检查的类型，例如：CTOR_DEF,METHOD_DEF,STATIC_INIT,INSTANCE_INITFileLengthmax: 定义一个文件所能容许的行数AnonInnerLength检查匿名内部类
max: 定义匿名内部类最多容许的行数MethodParamPad检查方法参数的格式
allowLineBreaks: 参数是否允许在不同行（注：没有作用）
option: 在参数和括号、参数和标识符之间是否包含空格OperatorWrap检查运算符是否在应在同一行
option: 定义运算符的位置，eol在同一行，nl在下一行
tokens: 定义检查的类型ParenPad检查左小括号'('后边和右小括号')'前边是否有空格
option: space表示有空格，nospace表示没有空格
tokens: 定义检查的类型TypecastParenPad暂不清楚TabCharacter检查源码中是否包含\tWhitespaceAfter检查类型后是否包含空格
tokens: 检查的类型WhitespaceAround暂不清楚ModifierOrder检查修饰符的顺序，默认是 public,protected,private,abstract,static,final,transient,volatile,synchronized,native,strictfp（注：定义不起作用）RedundantModifier检查是否有多余的修饰符，例如：接口中的方法不必使用public、abstract修饰
tokens: 检查的类型EmptyBlock检查是否有空代码块
option: 定义代码块中应该包含的内容，例如：stmt表示语句
tokens: 检查的类型NeedBraces检查是否应该使用括号的地方没有加括号
tokens: 定义检查的类型AvoidNestedBlocks检查是否有嵌套的代码块
allowInSwitchCase: 定义是否允许switch case中使用嵌套的代码块ArrayTrailingComma检查初始化数祖时，最后一个元素后面是否加了逗号，如果左右大括号都在同一行，则可以不加逗号AvoidInlineConditionals检查是否在同一行初始化，例如：private int Age = nGe==1 ? 100 : 0; 就应该避免CovariantEquals暂不清楚ModifiedControlVariable检查循环控制变量是否被修改SimplifyBooleanExpression检查是否有boolean使用冗余的地方，例如：b == true、b || true，应该简化为 b、bSimplifyBooleanReturn检查是否在返回boolean值时是否有使用冗余的地方，例如：
    if(valid())
        return true;
    else
        return false;
应该改为：
    return valid();StringLiteralEquality检查在判断字符串是否相等时是否使用了正确的形式EqualsHashCode检查在重写了equals方法后是否重写了hashCode方法FinalLocalVariable检查变量值没有改动的情况下，该变量是否定义成了finalMissingSwitchDefault检查switch语句是否忘记了default标签RedundantThrows检查是否抛出了多余的异常DefaultComesLast检查switch中default是否在所有case的后面MissingCtor检查类中是否显式定义了构造器FallThrough检查switch中case后是否加入了跳出语句，例如：return、break、throw、continueMultipleStringLiterals检查一个字符串变量在不改变变量值的情况下或者字符串出现的次数
allowedDuplicates: 定义在类中一个字符串变量在不改变变量值的情况下或者字符串所能使用的最多次数MultipleVariableDeclarations检查一次声明多个变量时，变量是否在同一行或者在同一个语句中RequireThis检查是否使用了this
checkFields: 是否检查变量引用
checkMethods: 是否检查方法调用UnnecessaryParentheses检查是否使用了多余的小括号VisibilityModifier检查变量是否对外部可见
packageAllowed: 变量包内成员可以访问
protectedAllowed: 变量是受保护的
publicMemberPattern: 可以公开访问的变量所匹配的命名形式FinalClass只有私有构造器的类必须声明为finalInterfaceIsType检查接口是否只定义了变量而没有定义方法，因为接口应该用来描述一个类型，所以只定义变量而不定义方法是不恰当的
allowMarkerInterfaces: 是否检查空接口HideUtilityClassConstructor只定义了静态方法的类不应该定义一个公有的构造器DesignForExtension检查类是否被设计为可扩展的，如果是，则方法应该abstract、final或者是空的ThrowsCount检查抛出异常的数量
max: 定义抛出异常的最大数目StrictDuplicateCode检查类中是否有代码复制的问题
min: 允许代码重复的最小行数
charset: 文件所用的字符集BooleanExpressionComplexitymax: 布尔运算符在一条语句中允许出现的最大数目GenericIllegalRegexp检查代码中是否有不合适的引用形式或者字符
format: 定义检查所匹配的类型
ignoreCase: 是否区分大小写
ignoreComments: 是否忽略注释
message: 出现问题应该显示给用户的信息NewlineAtEndOfFile检查文件是否以一个新行结束
lineSeparator: 行分隔符的类型，windows是crlfUncommentedMain检查是否有没有被注掉或者删除的main方法
excludedClasses: 定义可以带main方法的类所匹配的名字形式UpperEll检查初始化长整型变量时，数字後是加了大写字母'L'而不是小写字母'l'ArrayTypeStyle检查再定义数组时，采用java风格还是c风格，例如：int[] num是java风格，int num[]是c风格
javaStyle: 定义是否采用java风格定义数组FinalParameters检查参数是否是常量
tokens: 定义检查的类型Indentation检查代码的缩进是否符合要求
basicOffset: 定义代码体相对于所属的代码体的缩进量
braceAdjustment: 定义括号的缩进量
caseIndent: 定义case的缩进量RequiredRegexp检查文件中是否存在相应的文字
format: 定义所匹配的形式usage.OneMethodPrivateField检查是否只有一个方法访问了私有变量
ignoreFormat: 定义可以忽略的变量所匹配的命名形式usage.UnusedLocalVariable检查是否有命名後没有使用的变量
ignoreFormat: 定义可以忽略的变量所匹配的命名形式usage.UnusedParameter检查是否有没有使用的参数
ignoreFormat: 定义可以忽略的变量所匹配的命名形式
ignoreCatch: 是否忽略catch中的参数
ignoreNonLocal: 是否忽略非本地的变量usage.UnusedPrivateField检查是否存在未被使用的私有成员变量
ignoreFormat: 定义可以忽略的变量所匹配的命名形式usage.UnusedPrivateMethod检查是否存在未被使用的私有方法
ignoreFormat: 定义可以忽略的变量所匹配的命名形式

一个checkstyle文件的例子：

<?xml version="1.0"?>
<!DOCTYPE module PUBLIC
"-//Puppy Crawl//DTD Check Configuration 1.2//EN"
"http://www.puppycrawl.com/dtds/configuration_1_2.dtd">
<module name="Checker">
<property name="basedir" value="${check.src}"/>
<property name="localeCountry" value="CN"/>
<property name="localeLanguage" value="cn"/>
<metadata name="com.atlas-sw.eclipse" value="I like Sydney"/>
<property name="severity" value="error"/>
<module name="SuppressionFilter">
<property name="file" value="${check.filter.file}"/>
</module>
<module name="PackageHtml">
<property name="fileExtensions" value="java,properties"/>
</module>
<module name="Translation">
<property name="severity" value="info"/>
</module>
<module name="StrictDuplicateCode">
<property name="min" value="7"/>
<property name="charset" value="UTF-8"/>
</module>
<module name="NewlineAtEndOfFile">
</module>
<module name="TreeWalker">
<module name="AbstractClassName">
<property name="format" value="^Abstract.*$|^.*Factory$"/>
</module>
<module name="ImportOrder">
<property name="groups" value="java,javax"/>
<property name="ordered" value="true"/>
<property name="separated" value="true"/>
<property name="caseSensitive" value="true"/>
</module>
<module name="ExecutableStatementCount">
<property name="max" value="20"/>
<property name="tokens" value="CTOR_DEF,METHOD_DEF,STATIC_INIT,INSTANCE_INIT"/>
</module>
<module name="AnonInnerLength">
<property name="max" value="20"/>
</module>
<module name="EmptyForInitializerPad">
<property name="option" value="space"/>
</module>
<module name="EmptyForIteratorPad">
<property name="option" value="space"/>
</module>
<module name="MethodParamPad">
<property name="allowLineBreaks" value="false"/>
<property name="option" value="space"/>
<property name="tokens" value="METHOD_DEF,CTOR_DEF"/>
</module>
<module name="NoWhitespaceAfter">
<property name="allowLineBreaks" value="true"/>
</module>
<module name="NoWhitespaceBefore">
<property name="allowLineBreaks" value="true"/>
</module>
<module name="TypecastParenPad">
<property name="option" value="space"/>
</module>
<module name="ParenPad">
<property name="option" value="nospace"/>
</module>
<module name="WhitespaceAfter">
<property name="tokens" value="COMMA,SEMI,TYPECAST"/>
</module>
<module name="WhitespaceAround">
<property name="tokens" value="ASSIGN"/>
</module>
<module name="ModifierOrder"/>
<module name="RedundantModifier">
<property name="tokens" value="METHOD_DEF,VARIABLE_DEF"/>
</module>
<module name="AvoidNestedBlocks">
<property name="allowInSwitchCase" value="true"/>
</module>
<module name="MissingSwitchDefault"/>
<module name="ModifiedControlVariable"/>
<module name="RedundantThrows">
<property name="allowUnchecked" value="true"/>
<property name="allowSubclasses" value="true"/>
</module>
<module name="StringLiteralEquality"/>
<module name="SuperClone"/>
<module name="SuperFinalize"/>
<module name="IllegalCatch"/>
<module name="PackageDeclaration"/>
<module name="ReturnCount">
<property name="max" value="3"/>
</module>
<module name="DeclarationOrder"/>
<module name="ParameterAssignment"/>
<module name="DefaultComesLast"/>
<module name="FallThrough"/>
<module name="MultipleStringLiterals">
<property name="allowedDuplicates" value="3"/>
</module>
<module name="MultipleVariableDeclarations"/>
<module name="RequireThis">
<property name="checkFields" value="false"/>
<property name="checkMethods" value="false"/>
</module>
<module name="UnnecessaryParentheses"/>
<module name="HideUtilityClassConstructor"/>
<module name="ThrowsCount">
<property name="max" value="7"/>
</module>
<module name="BooleanExpressionComplexity">
<property name="max" value="7"/>
</module>
<module name="ClassDataAbstractionCoupling">
<property name="max" value="7"/>
</module>
<module name="AvoidInlineConditionals"/>
<module name="CovariantEquals"/>
<module name="HiddenField">
</module>
<module name="InterfaceIsType">
<property name="allowMarkerInterfaces" value="true"/>
</module>
<module name="UncommentedMain">
<property name="excludedClasses" value="^$"/>
</module>
<module name="ArrayTypeStyle">
<property name="javaStyle" value="true"/>
</module>
<module name="Indentation">
<property name="basicOffset" value="4"/>
<property name="braceAdjustment" value="0"/>
<property name="caseIndent" value="4"/>
</module>
<module name="RequiredRegexp">
<property name="format" value="^$"/>
</module>
<module name="usage.OneMethodPrivateField">
<property name="ignoreFormat" value="^$"/>
</module>
<module name="usage.UnusedLocalVariable">
<property name="ignoreFormat" value="^$"/>
</module>
<module name="usage.UnusedParameter">
<property name="ignoreFormat" value="^$"/>
<property name="ignoreCatch" value="true"/>
<property name="ignoreNonLocal" value="false"/>
</module>
<module name="usage.UnusedPrivateField">
<property name="ignoreFormat" value="^$"/>
</module>
<module name="usage.UnusedPrivateMethod">
<property name="ignoreFormat" value="^$"/>
</module>
<property name="cacheFile" value="${checkstyle.dir}/cacheFile"/>
<property name="fileExtensions" value="java,ejb,jpf"/>
<property name="charset" value="UTF-8"/>
<property name="tabWidth" value="4" />
<module name="FileContentsHolder">
</module>
<module name="GenericIllegalRegexp">
<property name="format" value="\s$"/>
<property name="ignoreCase" value="true"/>
<property name="ignoreComments" value="true"/>
<property name="message" value="wrong used"/>
</module>
<module name="AvoidStarImport">
<property name="excludes" value="java.io,java.util"/>
</module>
<module name="ConstantName">
<property name="format" value="^[A-Z][A-Z0-9]*(_[A-Z0-9]+)*$"/>
</module>
<module name="EmptyBlock">
<property name="option" value="stmt"/>
</module>
<module name="EqualsHashCode"/>
<module name="FileLength">
<property name="max" value="1000"/>
</module>
<module name="IllegalImport">
</module>
<module name="IllegalInstantiation"/>
<module name="InnerAssignment"/>
<module name="JavadocType">
<property name="authorFormat" value="\S"/>
<property name="scope" value="protected"/>
<property name="versionFormat" value="\$Revision.*\$"/>
<property name="excludeScope" value="public"/>
<property name="tokens" value="CLASS_DEF,INTERFACE_DEF"/>
</module>
<module name="JavadocMethod">
<property name="scope" value="private"/>
<property name="allowMissingParamTags" value="false"/>
<property name="allowMissingThrowsTags" value="false"/>
<property name="allowMissingReturnTag" value="false"/>
<property name="tokens" value="METHOD_DEF"/>
<property name="allowUndeclaredRTE" value="true"/>
<property name="allowThrowsTagsForSubclasses" value="true"/>
</module>
<module name="JavadocVariable">
<property name="scope" value="private"/>
</module>
<module name="JavadocStyle">
<property name="scope" value="public"/>
<property name="checkFirstSentence" value="true"/>
<property name="checkEmptyJavadoc" value="true"/>
<property name="checkHtml" value="true"/>
</module>
<module name="LeftCurly">
<property name="option" value="eol"/>
<property name="maxLineLength" value="80"/>
<property name="tokens"
value="CLASS_DEF,INTERFACE_DEF,METHOD_DEF,CTOR_DEF"/>
</module>
<module name="LineLength">
<property name="max" value="80"/>
<property name="ignorePattern" value="^ *\* *[^ ]+$"/>
</module>
<module name="LocalFinalVariableName">
<property name="format" value="^[A_Z][A-Z0-9]*(_[A_Z0-9]+)*$"/>
</module>
<module name="LocalVariableName">
<property name="format" value="^[a-z][a-zA-Z0-9]*$"/>
</module>
<module name="MemberName">
<property name="format" value="^[a-z][a-zA-Z0-9]*$"/>
<property name="applyToPublic" value="true"/>
<property name="applyToProtected" value="true"/>
<property name="applyToPackage" value="true"/>
<property name="applyToPrivate" value="true"/>
</module>
<module name="MethodLength">
<property name="max" value="100"/>
<property name="countEmpty" value="true"/>
<property name="tokens" value="METHOD_DEF"/>
</module>
<module name="MethodName">
<property name="format" value="^[a-z][a-zA-Z0-9]*$"/>
</module>
<module name="ModifierOrder"/>
<module name="NeedBraces">
</module>
<module name="OperatorWrap">
<property name="tokens"
value="ASSIGN, DIV, DIV_ASSIGN, PLUS_ASSIGN, MINUS, MINUS_ASSIGN, STAR, STAR_ASSIGN, MOD, MOD_ASSIGN, SR, SR_ASSIGN, BSR, BSR_ASSIGN, SL, SL_ASSIGN, BXOR, BXOR_ASSIGN, BOR, BOR_ASSIGN, BAND, BAND_ASSIGN,PLUS, QUESTION"/>
<property name="option" value="eol"/>
</module>
<module name="PackageName">
<property name="format" value="^[a-z]+(\.[a-z][a-z0-9]*)*$"/>
</module>
<module name="ParameterName">
<property name="format" value="^[a-z][a-zA-Z0-9]*$"/>
</module>
<module name="ParameterNumber">
<property name="max" value="10"/>
<property name="tokens" value="METHOD_DEF,CTOR_DEF"/>
</module>
<module name="RedundantImport"/>
<module name="RedundantModifier"/>
<module name="RightCurly">
<property name="option" value="alone"/>
<property name="tokens" value="LITERAL_TRY"/>
</module>
<module name="SimplifyBooleanExpression"/>
<module name="SimplifyBooleanReturn"/>
<module name="StaticVariableName">
<property name="format" value="^[a-z][a-zA-Z0-9]*$"/>
</module>
<module name="TypeName">
<property name="format" value="^[A-Z][a-zA-Z0-9]*$"/>
<property name="tokens" value="CLASS_DEF,INTERFACE_DEF"/>
</module>
<module name="UnusedImports"/>
<module name="UpperEll"/>
<module name="VisibilityModifier">
<property name="packageAllowed" value="false"/>
<property name="protectedAllowed" value="false"/>
<property name="publicMemberPattern" value="^seriaVersionUID$"/>
</module>
<module name="WhitespaceAround"/>
<module name="FinalClass"/>
<module name="MissingSwitchDefault"/>
<module name="Indentation">
<property name="basicOffset" value="4"/>
<property name="braceAdjustment" value="0"/>
<property name="caseIndent" value="0"/>
</module>
<module name="ArrayTrailingComma"/>
<module name="CyclomaticComplexity">
<property name="severity" value="ignore"/>
</module>
<module name="NestedIfDepth">
<property name="max" value="1"/>
</module>
<module name="NestedTryDepth">
<property name="max" value="3"/>
</module>
<module name="ExplicitInitialization"/>
</module>
</module>