关于checkstyle的部分规则说明

2009-12-28 09:37

<!--*******Size Violations*********--> <!--测试类中的长度如果超过1000就按出错处理-->    <module name = "FileLength">      <property name = "max" value = "90"/> </module> <module name = "LineLength"> <property name = "max" value = "40"/> </module> <!--对方法实行长度测试定义，如果长度长于20行的就按出错处理-->    <module name = "MethodLength">       <property name = "max" value = "20"/>       <property name = "tokens" value ="METHOD_DEF"/>    <!--把单行注释和空行除掉-->       <property name = "countEmpty" value = "false"/> </module> <!--检查方法和构造函数的参数个数,现在以10个参数个数为例--> <module name = "ParameterNumber"> <property name = "max" value = "10"/> <property name = "tokens" value = "METHOD_DEF"/> </module> <!--******Naming Conventions******--> <!--检查参数的命名格式--> <module name = "ParameterName"> <property name = "format" value = "^[a-z][a-zA-Z0-9]*$"/> </module>     <!--检查包命名--> <module name = "PackageName" > </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 = "MethodName"> <property name ="format" value = "^[a-z][a-zA-Z0-9]*$"/> </module> <!--检查局部的final类型变量名，包括catch的参数--> <module name = "LocalFinalVariableName"> </module> <!--检查局部的非final类型变量名，包括catch的参数--> <module name = "LocalVariableName"> </module> <!--检查非静态变量--> <module name = "MemberName"> </module> <!--*****Imports******--> <!--检查是否有使用*进行import--> <module name = "AvoidStarImport"> </module> <!--检查是否有静态的import，比如是否导入了java.lang包中的内容--> <module name = "AvoidStaticImport"> </module> <!--是否import了违法的包，默认拒绝import所以sun.*包--> <module name= "IllegalImport"> </module> <!--检查是否有重复的import--> <module name = "RedundantImport"> </module> <!--检查import而未有使用过的import--> <module name ="UnusedImports"> </module> <!--******Block Checks******--> <!--检查是否需要大括号。主要是在if，else时的情况.(貌似没这个必要，可以省略该项)--> <module name = "NeedBraces"> </module> <!--检查不需要的嵌套’{}’。--> <module name = "AvoidNestedBlocks" /> <!--*********Coding**********--> <!--检查数组初始化是否以逗号结束。--> <module name = "ArrayTrailingComma"/> <!--检查一个可能为null的字符串是否在equals()比较的左边。--> <module name = "EqualsAvoidNull"/> <!--检查switch语句是否有default的clause--> <module name = "MissingSwitchDefault"/> <!--检查循环控制的变量是否在代码块中被修改。--> <module name = "ModifiedControlVariable"/> <!--检查是否有被重复抛出的异常。--> <module name = "RedundantThrows"> <property name = "allowUnchecked" value = "true"/> </module> <!--检查是否有过度复杂的布尔表达式。--> <module name = "SimplifyBooleanExpression"/> <!--检查字符串是否有用= =或!=进行操作。--> <module name = "StringLiteralEquality"/> <!--检查嵌套的层次深度是否超过最大值3。--> <module name = "NestedIfDepth"> <property name = "max" value = "3"/> </module> <!--检查try的层次深度是否超过2--> <module name = "NestedTryDepth"> <property name = "max" value = "2"/> </module> <!--检查是否catch了不能接受的错误。--> <module name = "IllegalCatch"/> <!--检查是否抛出了未声明的异常。--> <module name = "IllegalThrows"/> <!--检查类中是否有声明package。--> <module name = "PackageDeclaration"/> <!--检查未使用过的类。--> <module name = "IllegalType"> <property name = "ignoredMethodNames" value = "getInstance"/> </module> <!--找出没有定义的构造函数的类，检查类依赖--> <module name = "MissingCtor"/> <!--********Miscellaneous********--> <!--检查TODO:注释。--> <module name = "TodoComment"> <property name = "format" value = "WARNING"/> </module> 未解决： <!--检查import的分组和顺序--> <module name = "ImportOrder"> </module> 说明：未经同意不得转载！