Checkstyle配置文件的简要说明

Checkstyle配置文件的简要说明
关于配置文件的各个模块的更多细节，请参考CHECKSTYLE_HOME/docs/index.html
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE module PUBLIC "-//Puppy Crawl//DTD Check Configuration 1.2//EN"
"http://www.puppycrawl.com/dtds/configuration_1_2.dtd">
<!-- 对于所有的模块来书,如果有这个模块则说明检测这一项,没有则不检测这一项-->
<!-- 所有的模块中,其ROOT必须为Checker-->
<modulename="Checker">
<!-- 检验每个包是否存在package.html文件-->
<!-- See http://checkstyle.sf.net/config_javadoc.html#PackageHtml-->
<!--
<module name="PackageHtml"/>
-->
<!-- 检验每个文件末尾是否有一个空行-->
<!-- See http://checkstyle.sf.net/config_misc.html#NewlineAtEndOfFile-->
<!--
<module name="NewlineAtEndOfFile"/>
-->
<!-- Checks that property files contain the same keys.-->
<!-- See http://checkstyle.sf.net/config_misc.html#Translation-->
<modulename="Translation"/>
<modulename="TreeWalker">
<!-- Checks for Javadoc comments.-->
<!-- See http://checkstyle.sf.net/config_javadoc.html-->
<!-- Checks Javadoc comments for method definitions.-->
<modulename="JavadocMethod">
<propertyname="scope" value="public"/>
<!-- 是否允许错误的参数声明,true为允许,缺省为不允许-->
<propertyname="allowMissingParamTags" value="true"/>
<!-- 是否允许错误的错误声明,true为允许,缺省为不允许-->
<propertyname="allowMissingThrowsTags" value="true"/>
<!-- 是否允许错误的返回类型声明,true为允许,缺省为不允许-->
<propertyname="allowMissingReturnTag" value="true"/>
</module>
<!--Checks Javadoc comments for class and interface definitions.-->
<modulename="JavadocType"/>
<!-- Checks that variables have Javadoc comments.-->
<modulename="JavadocVariable">
<propertyname="scope" value="protected"/>
</module>
<!-- 检查Javadoc的格式-->
<modulename="JavadocStyle">
<propertyname="scope" value="public"/>
<!-- Comment的第一句的末尾是否要有一个句号,true必须有,default为true-->
<propertyname="checkFirstSentence" value="false"/>
<!-- 检查错误的HTML脚本,比如不匹配,true检查,default为true-->
<propertyname="checkHtml" value="true"/>
</module>
<!-- Checks for Naming Conventions.-->
<!-- See http://checkstyle.sf.net/config_naming.html-->
<!-- 确省必须以Abstract开始或者以Factory结束-->
<!--
<module name="AbstractClassName"/>
-->
<modulename="ConstantName"/>
<modulename="LocalFinalVariableName"/>
<modulename="LocalVariableName"/>
<modulename="MemberName"/>
<modulename="MethodName"/>
<modulename="PackageName"/>
<modulename="ParameterName"/>
<modulename="StaticVariableName"/>
<modulename="TypeName"/>
<!-- Checks for Headers-->
<!-- See http://checkstyle.sf.net/config_header.html-->
<!-- 检查文件是否以指定文件开始,这里最好是放一些版权信息和工程描述-->
<!-- headerFile:指定的文件-->
<!-- ignoreLines:忽略哪些行,以","分隔-->
<!--
<module name="Header">
<property name="headerFile" value="java.header"/>
<property name="ignoreLines" value="2, 3, 4, 5"/>
</module>
-->
<!-- Following interprets the header file as regular expressions.-->
<!--
<module name="RegexpHeader"/>
-->
<!-- Checks for imports-->
<!-- See http://checkstyle.sf.net/config_import.html-->
<!-- 检查使用*号的导入,默认为全部类-->
<modulename="AvoidStarImport"/>
<!-- 检查是否有非法的包,确省检查sun.*;对于某些包是不建议直接调用的-->
<modulename="IllegalImport">
<propertyname="illegalPkgs" value="sun.*"/>
</module>
<!-- 检查多于的导入,如一个类导入了多次-->
<modulename="RedundantImport"/>
<!-- 检查没有使用的导入-->
<modulename="UnusedImports"/>
<!-- 导入排序-->
<!-- groups:分组,哪些是一组的-->
<!-- ordered:同一个组内是否排序,true排序,确省为true-->
<!-- separated:各个组之间是否需要用空行分隔,确省为false-->
<!-- caseSensitive:是否是大小写敏感的,确省是-->
<!--
<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>
-->
<!-- Checks for Size Violations.-->
<!-- See http://checkstyle.sf.net/config_sizes.html-->
<!-- 检查方法内可执行语句的个数,确省为30行-->
<!--
<module name="ExecutableStatementCount">
<property name="max" value="30"/>
</module>
-->
<!-- 文件的最大行数,缺省为1500-->
<modulename="FileLength">
<propertyname="max" value="2000"/>
</module>
<!-- 每行的最大字符数,缺省为80-->
<modulename="LineLength">
<!-- 忽略指定格式的行,如*号开始的,等-->
<!--
<property name="ignorePattern" value="^ *\* *[^ ]+$"/>
-->
<propertyname="max" value="120"/>
</module>
<!-- 方法的最大行数,缺省为150-->
<modulename="MethodLength">
<propertyname="max" value="200"/>
<!-- 统计时是否包括空行和以//开始的注释,缺省为统计(true)-->
<propertyname="countEmpty" value="false"/>
</module>
<!-- 匿名类的最大行数,缺省为20-->
<modulename="AnonInnerLength">
<propertyname="max" value="60"/>
</module>
<!-- 检查方法和构造子参数的最大个数,缺省为7-->
<modulename="ParameterNumber"/>
<!-- Checks for whitespace-->
<!-- See http://checkstyle.sf.net/config_whitespace.html-->
<modulename="EmptyForInitializerPad"/>
<modulename="EmptyForIteratorPad"/>
<modulename="MethodParamPad">
<propertyname="allowLineBreaks" value="true"/>
</module>
<modulename="NoWhitespaceAfter"/>
<modulename="NoWhitespaceBefore"/>
<modulename="OperatorWrap"/>
<modulename="ParenPad"/>
<modulename="TypecastParenPad"/>
<modulename="TabCharacter"/>
<modulename="WhitespaceAfter"/>
<modulename="WhitespaceAround"/>
<!-- Modifier Checks-->
<!-- See http://checkstyle.sf.net/config_modifiers.html-->
<!-- 要求JLS suggestions-->
<!--
<module name="ModifierOrder"/>
-->
<modulename="RedundantModifier"/>
<!-- Checks for blocks. You know, those {}'s-->
<!-- See http://checkstyle.sf.net/config_blocks.html-->
<!-- 检查空块-->
<!--
<module name="EmptyBlock"/>
-->
<modulename="LeftCurly"/>
<!-- 检查只有必须有{},确省为必须,主要在if,else时有这样的情况-->
<modulename="NeedBraces"/>
<!-- 检查"}",确省在同一行-->
<modulename="RightCurly">
<propertyname="option" value="alone"/>
</module>
<!-- 检查多余嵌套的{},请看文档,不易说明-->
<modulename="AvoidNestedBlocks"/>
<!-- Checks for common coding problems-->
<!-- See http://checkstyle.sf.net/config_coding.html-->
<modulename="AvoidInlineConditionals"/>
<modulename="CovariantEquals"/>
<modulename="DeclarationOrder"/>
<modulename="DefaultComesLast"/>
<modulename="DoubleCheckedLocking"/>
<!--
<module name="EmptyStatement"/>
-->
<modulename="EqualsHashCode"/>
<!-- 变量必须初始化为自己的类型,如果给一个Object类型的变量初始化为null会提示-->
<!--
<module name="ExplicitInitialization"/>
-->
<modulename="FallThrough"/>
<!--
<module name="FinalLocalVariable"/>
-->
<modulename="HiddenField">
<propertyname="ignoreConstructorParameter" value="true"/>
<propertyname="ignoreSetter" value="true"/>
</module>
<!-- Exception, Throwable, RuntimeException是不允许catch的-->
<!--
<module name="IllegalCatch"/>
-->
<modulename="IllegalInstantiation"/>
<!--
<module name="IllegalToken"/>
-->
<modulename="IllegalTokenText"/>
<modulename="IllegalType"/>
<modulename="InnerAssignment"/>
<!--检查直接数
<module name="MagicNumber"/>
检查是否有构造子
<module name="MissingCtor"/>
-->
<modulename="MissingSwitchDefault"/>
<modulename="MultipleVariableDeclarations"/>
<!--
<module name="JUnitTestCase"/>
<module name="NestedIfDepth"">
<property name="max" value="5"/>
</module>
<module name="NestedTryDepth"">
<property name="max" value="5"/>
</module>
<module name="PackageDeclaration"/>
<module name="ReturnCount"/>
-->
<!-- 不能为参数付值-->
<!--
<module name="ParameterAssignment"/>
-->
<modulename="RedundantThrows"/>
<!-- 不能理解的,好像是bug
<module name="RequireThis"/>
-->
<modulename="SimplifyBooleanExpression"/>
<modulename="SimplifyBooleanReturn"/>
<modulename="StringLiteralEquality"/>
<modulename="SuperClone"/>
<modulename="SuperFinalize"/>
<modulename="UnnecessaryParentheses"/>
<!-- Checks for class design-->
<!-- See http://checkstyle.sf.net/config_design.html-->
<!-- 要求一个方法必须声明为Extension的,否则必声明为abstract, final or empty-->
<!--
<module name="DesignForExtension"/>
-->
<!-- 检查private构造子是否声明为final,这里有个问题,在Java中构造子是不能声明为final的-->
<!--
<module name="FinalClass"/>
-->
<!-- 要求一定要有一个构造子-->
<!--
<module name="HideUtilityClassConstructor"/>
-->
<modulename="InterfaceIsType"/>
<!-- 检查变量的可见性,确省只允许static final 为public,否则只能为private-->
<modulename="VisibilityModifier">
<propertyname="packageAllowed" value="true"/>
<propertyname="protectedAllowed" value="true"/>
</module>
<!--
<module name="MutableException"/>
-->
<!-- 限制抛出声明的指定数量,确省为1-->
<!--
<module name="ThrowsCount"/>
-->
<!-- Miscellaneous other checks.-->
<!-- See http://checkstyle.sf.net/config_misc.html-->
<!-- 数组的声明是否允许Java的类型,确省为允许,Java类型为String[] xx,C++的类型为String xx[];-->
<modulename="ArrayTypeStyle"/>
<!--
<module name="FinalParameters"/>
-->
<!-- 一般性的代码问题,不好的习惯等,可以多-->
<!-- 文件中使用了System.out.print等-->
<modulename="GenericIllegalRegexp">
<propertyname="format" value="System\.out\.print"/>
<propertyname="message" value="bad practice of use System.out.print"/>
</module>
<modulename="GenericIllegalRegexp">
<propertyname="format" value="System\.exit"/>
<propertyname="message" value="bad practice of use System.exit"/>
</module>
<modulename="GenericIllegalRegexp">
<propertyname="format" value="printStackTrace"/>
<propertyname="message" value="bad practice of use printStackTrace"/>
</module>
<!-- 关于Task,你可以声明自己的Task标识-->
<modulename="TodoComment">
<propertyname="format" value="TODO"/>
</module>
<!-- 强迫//注释必须如何,入下要求只能有一行,具体看文档-->
<!--
<module name="TrailingComment">
<property name="format" value="^\\s*$"/>
</module>
-->
<!-- main方法经常会在debug时使用,但发行版本的时候可能并不需要这个方法,提示-->
<!--
<module name="UncommentedMain"/>
-->
<!-- 当定义一个常量时,希望使用大写的L来代替小写的l,原因是小写的l和数字1很象-->
<modulename="UpperEll"/>
<!-- 检查正确的缩进,这个更象是个人习惯-->
<!--
<module name="Indentation">
<property name="braceAdjustment" value="0"/>
</module>
-->
<!-- Checks For Metrics-->
<!-- See http://checkstyle.sf.net/config_metrics.html-->
<!-- 检查嵌套复杂度-->
<modulename="CyclomaticComplexity">
<propertyname="max" value="12"/>
</module>
</module>
</module>
Checkstyle常见的输出结果
1．Type is missing a javadoc commentClass
缺少类型说明
2．“{” should be on the previous line
“{” 应该位于前一行
3．Methods is missing a javadoc comment
方法前面缺少javadoc注释
4．Expected @throws tag for “Exception”
在注释中希望有@throws的说明
5．“.” Is preceeded with whitespace “.”
前面不能有空格
6．“.” Is followed by whitespace“.”
后面不能有空格
7．“=” is not preceeded with whitespace
“=” 前面缺少空格
8．“=” is not followed with whitespace
“=” 后面缺少空格
9．“}” should be on the same line
“}” 应该与下条语句位于同一行
10．Unused @param tag for “unused”
没有参数“unused”，不需注释
11．Variable “CA” missing javadoc
变量“CA”缺少javadoc注释
12．Line longer than 80characters
行长度超过80
13．Line contains a tab character
行含有”tab” 字符
14．Redundant “Public” modifier
冗余的“public” modifier
15．Final modifier out of order with the JSL
suggestionFinal modifier的顺序错误
16．Avoid using the “.*” form of import
Import格式避免使用“.*”
17．Redundant import from the same package
从同一个包中Import内容
18．Unused import-java.util.list
Import进来的java.util.list没有被使用
19．Duplicate import to line 13
重复Import同一个内容
20．Import from illegal package
从非法包中 Import内容
21．“while” construct must use “{}”
“while” 语句缺少“{}”
22．Variable “sTest1” must be private and have accessor method
变量“sTest1”应该是private的，并且有调用它的方法
23．Variable “ABC” must match pattern “^[a-z][a-zA-Z0-9]*$”
变量“ABC”不符合命名规则“^[a-z][a-zA-Z0-9]*$”
24．“(” is followed by whitespace
“(” 后面不能有空格
25．“)” is proceeded by whitespace
“)” 前面不能有空格


码同行的注释-->
159<module name="TrailingComment"/>
160</module>
161<!-- 检查翻译文件-->
162<module name="Translation"/>
163</module>
164