|
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE module PUBLIC "-//Puppy Crawl//DTD Check Configuration 1.2//EN"
"http://www./dtds/configuration_1_2.dtd">
<!-- 對于所有的模塊來書,如果有這個模塊則說明檢測這一項,沒有則不檢測這一項 -->
<!-- 所有的模塊中,其ROOT必須為Checker -->
<module name="Checker">
<!-- 檢驗每個包是否存在package.html文件-->
<!-- See http://checkstyle./config_javadoc.html#PackageHtml -->
<!--
<module name="PackageHtml"/>
-->
<!-- 檢驗每個文件末尾是否有一個空行-->
<!-- See http://checkstyle./config_misc.html#NewlineAtEndOfFile -->
<!--
<module name="NewlineAtEndOfFile"/>
-->
<!-- Checks that property files contain the same keys. -->
<!-- See http://checkstyle./config_misc.html#Translation -->
<module name="Translation"/>
<module name="TreeWalker">
<!-- Checks for Javadoc comments. -->
<!-- See http://checkstyle./config_javadoc.html -->
<!-- Checks Javadoc comments for method definitions.-->
<module name="JavadocMethod">
<property name="scope" value="public"/>
<!-- 是否允許錯誤的參數(shù)聲明,true為允許,缺省為不允許 -->
<property name="allowMissingParamTags" value="true"/>
<!-- 是否允許錯誤的錯誤聲明,true為允許,缺省為不允許 -->
<property name="allowMissingThrowsTags" value="true"/>
<!-- 是否允許錯誤的返回類型聲明,true為允許,缺省為不允許 -->
<property name="allowMissingReturnTag" value="true"/>
</module>
<!--Checks Javadoc comments for class and interface definitions.-->
<module name="JavadocType"/>
<!-- Checks that variables have Javadoc comments.-->
<module name="JavadocVariable">
<property name="scope" value="protected"/>
</module>
<!-- 檢查Javadoc的格式 -->
<module name="JavadocStyle">
<property name="scope" value="public"/>
<!-- Comment的第一句的末尾是否要有一個句號,true必須有,default為true -->
<property name="checkFirstSentence" value="false"/>
<!-- 檢查錯誤的HTML腳本,比如不匹配,true檢查,default為true -->
<property name="checkHtml" value="true"/>
</module>
<!-- Checks for Naming Conventions. -->
<!-- See http://checkstyle./config_naming.html -->
<!-- 確省必須以Abstract開始或者以Factory結束 -->
<!--
<module name="AbstractClassName"/>
-->
<module name="ConstantName"/>
<module name="LocalFinalVariableName"/>
<module name="LocalVariableName"/>
<module name="MemberName"/>
<module name="MethodName"/>
<module name="PackageName"/>
<module name="ParameterName"/>
<module name="StaticVariableName"/>
<module name="TypeName"/>
<!-- Checks for Headers -->
<!-- See http://checkstyle./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./config_import.html -->
<!-- 檢查使用*號的導入,默認為全部類 -->
<module name="AvoidStarImport"/>
<!-- 檢查是否有非法的包,確省檢查sun.*;對于某些包是不建議直接調用的 -->
<module name="IllegalImport">
<property name="illegalPkgs" value="sun.*"/>
</module>
<!-- 檢查多于的導入,如一個類導入了多次 -->
<module name="RedundantImport"/>
<!-- 檢查沒有使用的導入 -->
<module name="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./config_sizes.html -->
<!-- 檢查方法內可執(zhí)行語句的個數(shù),確省為30行 -->
<!--
<module name="ExecutableStatementCount">
<property name="max" value="30"/>
</module>
-->
<!-- 文件的最大行數(shù),缺省為1500 -->
<module name="FileLength">
<property name="max" value="2000"/>
</module>
<!-- 每行的最大字符數(shù),缺省為80 -->
<module name="LineLength">
<!-- 忽略指定格式的行,如*號開始的,等 -->
<!--
<property name="ignorePattern" value="^ */* *[^ ]+$"/>
-->
<property name="max" value="120"/>
</module>
<!-- 方法的最大行數(shù),缺省為150 -->
<module name="MethodLength">
<property name="max" value="200"/>
<!-- 統(tǒng)計時是否包括空行和以//開始的注釋,缺省為統(tǒng)計(true)-->
<property name="countEmpty" value="false"/>
</module>
<!-- 匿名類的最大行數(shù),缺省為20 -->
<module name="AnonInnerLength">
<property name="max" value="60"/>
</module>
<!-- 檢查方法和構造子參數(shù)的最大個數(shù),缺省為7 -->
<module name="ParameterNumber"/>
<!-- Checks for whitespace -->
<!-- See http://checkstyle./config_whitespace.html -->
<module name="EmptyForInitializerPad"/>
<module name="EmptyForIteratorPad"/>
<module name="MethodParamPad">
<property name="allowLineBreaks" value="true"/>
</module>
<module name="NoWhitespaceAfter"/>
<module name="NoWhitespaceBefore"/>
<module name="OperatorWrap"/>
<module name="ParenPad"/>
<module name="TypecastParenPad"/>
<module name="TabCharacter"/>
<module name="WhitespaceAfter"/>
<module name="WhitespaceAround"/>
<!-- Modifier Checks -->
<!-- See http://checkstyle./config_modifiers.html -->
<!-- 要求JLS suggestions -->
<!--
<module name="ModifierOrder"/>
-->
<module name="RedundantModifier"/>
<!-- Checks for blocks. You know, those {}'s -->
<!-- See http://checkstyle./config_blocks.html -->
<!-- 檢查空塊 -->
<!--
<module name="EmptyBlock"/>
-->
<module name="LeftCurly"/>
<!-- 檢查只有必須有{},確省為必須,主要在if,else時有這樣的情況 -->
<module name="NeedBraces"/>
<!-- 檢查"}",確省在同一行 -->
<module name="RightCurly">
<property name="option" value="alone"/>
</module>
<!-- 檢查多余嵌套的{},請看文檔,不易說明 -->
<module name="AvoidNestedBlocks"/>
<!-- Checks for common coding problems -->
<!-- See http://checkstyle./config_coding.html -->
<module name="AvoidInlineConditionals"/>
<module name="CovariantEquals"/>
<module name="DeclarationOrder"/>
<module name="DefaultComesLast"/>
<module name="DoubleCheckedLocking"/>
<!--
<module name="EmptyStatement"/>
-->
<module name="EqualsHashCode"/>
<!-- 變量必須初始化為自己的類型,如果給一個Object類型的變量初始化為null會提示 -->
<!--
<module name="ExplicitInitialization"/>
-->
<module name="FallThrough"/>
<!--
<module name="FinalLocalVariable"/>
-->
<module name="HiddenField">
<property name="ignoreConstructorParameter" value="true"/>
<property name="ignoreSetter" value="true"/>
</module>
<!-- Exception, Throwable, RuntimeException是不允許catch的 -->
<!--
<module name="IllegalCatch"/>
-->
<module name="IllegalInstantiation"/>
<!--
<module name="IllegalToken"/>
-->
<module name="IllegalTokenText"/>
<module name="IllegalType"/>
<module name="InnerAssignment"/>
<!--檢查直接數(shù)
<module name="MagicNumber"/>
檢查是否有構造子
<module name="MissingCtor"/>
-->
<module name="MissingSwitchDefault"/>
<module name="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"/>
-->
<!-- 不能為參數(shù)付值 -->
<!--
<module name="ParameterAssignment"/>
-->
<module name="RedundantThrows"/>
<!-- 不能理解的,好像是bug
<module name="RequireThis"/>
-->
<module name="SimplifyBooleanExpression"/>
<module name="SimplifyBooleanReturn"/>
<module name="StringLiteralEquality"/>
<module name="SuperClone"/>
<module name="SuperFinalize"/>
<module name="UnnecessaryParentheses"/>
<!-- Checks for class design -->
<!-- See http://checkstyle./config_design.html -->
<!-- 要求一個方法必須聲明為Extension的,否則必聲明為abstract, final or empty -->
<!--
<module name="DesignForExtension"/>
-->
<!-- 檢查private構造子是否聲明為final,這里有個問題,在Java中構造子是不能聲明為final的 -->
<!--
<module name="FinalClass"/>
-->
<!-- 要求一定要有一個構造子 -->
<!--
<module name="HideUtilityClassConstructor"/>
-->
<module name="InterfaceIsType"/>
<!-- 檢查變量的可見性,確省只允許static final 為public,否則只能為private -->
<module name="VisibilityModifier">
<property name="packageAllowed" value="true"/>
<property name="protectedAllowed" value="true"/>
</module>
<!--
<module name="MutableException"/>
-->
<!-- 限制拋出聲明的指定數(shù)量,確省為1 -->
<!--
<module name="ThrowsCount"/>
-->
<!-- Miscellaneous other checks. -->
<!-- See http://checkstyle./config_misc.html -->
<!-- 數(shù)組的聲明是否允許Java的類型,確省為允許,Java類型為String[] xx,C++的類型為String xx[]; -->
<module name="ArrayTypeStyle"/>
<!--
<module name="FinalParameters"/>
-->
<!-- 一般性的代碼問題,不好的習慣等,可以多 -->
<!-- 文件中使用了System.out.print等-->
<module name="GenericIllegalRegexp">
<property name="format" value="System/.out/.print"/>
<property name="message" value="bad practice of use System.out.print"/>
</module>
<module name="GenericIllegalRegexp">
<property name="format" value="System/.exit"/>
<property name="message" value="bad practice of use System.exit"/>
</module>
<module name="GenericIllegalRegexp">
<property name="format" value="printStackTrace"/>
<property name="message" value="bad practice of use printStackTrace"/>
</module>
<!-- 關于Task,你可以聲明自己的Task標識 -->
<module name="TodoComment">
<property name="format" value="TODO"/>
</module>
<!-- 強迫//注釋必須如何,入下要求只能有一行,具體看文檔 -->
<!--
<module name="TrailingComment">
<property name="format" value="^//s*$"/>
</module>
-->
<!-- main方法經常會在debug時使用,但發(fā)行版本的時候可能并不需要這個方法,提示 -->
<!--
<module name="UncommentedMain"/>
-->
<!-- 當定義一個常量時,希望使用大寫的L來代替小寫的l,原因是小寫的l和數(shù)字1很象 -->
<module name="UpperEll"/>
<!-- 檢查正確的縮進,這個更象是個人習慣 -->
<!--
<module name="Indentation">
<property name="braceAdjustment" value="0"/>
</module>
-->
<!-- Checks For Metrics -->
<!-- See http://checkstyle./config_metrics.html -->
<!-- 檢查嵌套復雜度 -->
<module name="CyclomaticComplexity">
<property name="max" value="12"/>
</module>
</module>
</module>
|
