CheckStyle

CheckStyle示例

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

<!--
    Checkstyle configuration that checks the Google coding conventions from Google Java Style
    that can be found at https://google.github.io/styleguide/javaguide.html.

    Checkstyle is very configurable. Be sure to read the documentation at
    http://checkstyle.sf.net (or in your downloaded distribution).

    To completely disable a check, just comment it out or delete it from the file.

    Authors: Max Vetrenko, Ruslan Diachenko, Roman Ivanov.
 -->

<module name = "Checker">
    <property name="charset" value="UTF-8"/>
    <property name="severity" value="warning"/>
    <property name="basedir" value="${basedir}"/>
    <property name="fileExtensions" value="java, properties, xml"/>
    <!-- 检查文件的长度，default max=20000 -->
    <module name="FileLength"/>
    <!-- 检查文件中是否含有'\t' -->
    <module name="FileTabCharacter">
        <property name="eachLine" value="false"/>
        <property name="fileExtensions" value="all files"/>
    </module>
    <module name="TreeWalker">
        <!-- 必须导入完成的类名，不能使用*类型导入 -->
        <module name="AvoidStarImport"/>
        <!-- 检查是否从非法的包中导入了类 illegalPkgs: 定义非法的包名称-->    
        <module name="IllegalImport"/>
        <!-- 检查是否导入了不必显示导入的类-->    
        <module name="RedundantImport"/>    
        <!-- 检查是否导入的包没有使用-->    
        <module name="UnusedImports"/>  
        
        <!-- Checks for whitespace             
        <module name="EmptyForIteratorPad"/>  
        <module name="MethodParamPad"/>  
        <module name="NoWhitespaceAfter"/>  
        <module name="NoWhitespaceBefore"/>  
        <module name="OperatorWrap"/>  
        <module name="ParenPad"/>  
        <module name="TypecastParenPad"/>  
        <module name="WhitespaceAfter"/>  
        <module name="WhitespaceAround"/>  
        -->  
        <!-- 检查类和接口的javadoc 默认不检查author 和version tags         
            authorFormat: 检查author标签的格式  
            versionFormat: 检查version标签的格式  
            scope: 可以检查的类的范围，例如：public只能检查public修饰的类，private可以检查所有的类  
            excludeScope: 不能检查的类的范围，例如：public，public的类将不被检查，但访问权限小于public的类仍然会检查，其他的权限以此类推  
            tokens: 该属性适用的类型，例如：CLASS_DEF,INTERFACE_DEF 
        -->  
        <module name="JavadocType">    
            <property name="authorFormat" value="\S"/>    
            <property name="scope" value="private"/>          
            <property name="tokens" value="CLASS_DEF,INTERFACE_DEF"/>    
        </module>  
        <!-- 检查方法的javadoc的注释  
            scope: 可以检查的方法的范围，例如：public只能检查public修饰的方法，private可以检查所有的方法  
            allowMissingParamTags: 是否忽略对参数注释的检查  
            allowMissingThrowsTags: 是否忽略对throws注释的检查  
            allowMissingReturnTag: 是否忽略对return注释的检查 
        -->  
        
        <module name="JavadocMethod">    
            <property name="scope" value="public"/>    
            <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"/>
            <!--允许get set 方法没有注释-->  
            <property name="allowMissingPropertyJavadoc" value="true"/>  
        </module>
        
        <!-- 检查类变量的注释  
            scope: 检查变量的范围，例如：public只能检查public修饰的变量，private可以检查所有的变量 
        -->      
        <module name="JavadocVariable">    
          <property name="scope" value="public"/>    
        </module>    
        <!-- 
            option: 定义左大括号'{'显示位置，eol在同一行显示，nl在下一行显示    
            maxLineLength: 大括号'{'所在行行最多容纳的字符数    
            tokens: 该属性适用的类型，例：CLASS_DEF,INTERFACE_DEF,METHOD_DEF,CTOR_DEF 
        -->    
        <!--
        <module name="LeftCurly">   
            <property name="option" value="nl"/>  
        </module>
        -->
        <!-- 
            Checks the placement of right curly braces ('}') for  else, try, and catch tokens. The policy to verify is specified using property  option.     
            option: 右大括号是否单独一行显示    
            tokens: 定义检查的类型  
        -->    
        <!--
        <module name="RightCurly">      
            <property name="option" value="alone"/>     
        </module>  
        -->
        <!-- NeedBraces 检查是否应该使用括号的地方没有加括号    
            tokens: 定义检查的类型 
        -->    
        <module name="NeedBraces"/>
        <!-- 检查在重写了equals方法后是否重写了hashCode方法 -->   
        <module name="EqualsHashCode"/>
        
        <module name="LocalVariableName">
            <property name="tokens" value="VARIABLE_DEF"/>
            <property name="format" value="^[a-z]([a-z0-9][a-zA-Z0-9]*)?$"/>
            <message key="name.invalidPattern"
             value="Local variable name ''{0}'' must match pattern ''{1}''."/>
        </module>
        
        <module name="LineLength">
            <property name="max" value="100"/>
            <property name="ignorePattern" value="^package.*|^import.*|a href|href|http://|https://|ftp://"/>
        </module>
        
         <module name="PackageName">
            <property name="format" value="^[a-z]+(\.[a-z][a-z0-9]*)*$"/>
            <message key="name.invalidPattern"
             value="Package name ''{0}'' must match pattern ''{1}''."/>
        </module>
        
        <module name="TypeName">
            <message key="name.invalidPattern"
             value="Type name ''{0}'' must match pattern ''{1}''."/>
        </module>
        
        <module name="MethodName">
            <property name="format" value="^[a-z][a-z0-9][a-zA-Z0-9_]*$"/>
            <message key="name.invalidPattern"
             value="Method name ''{0}'' must match pattern ''{1}''."/>
        </module>
        
        <module name="MemberName">
            <property name="format" value="^[a-z][a-z0-9][a-zA-Z0-9]*$"/>
            <message key="name.invalidPattern"
             value="Member name ''{0}'' must match pattern ''{1}''."/>
        </module>
        <module name="ParameterName">
            <property name="format" value="^[a-z]([a-z0-9][a-zA-Z0-9]*)?$"/>
            <message key="name.invalidPattern"
             value="Parameter name ''{0}'' must match pattern ''{1}''."/>
        </module>
        <!-- 检查代码的进缩-->
        <!--
        <module name="Indentation">
            <property name="basicOffset" value="2"/>
            <property name="braceAdjustment" value="0"/>
            <property name="caseIndent" value="2"/>
            <property name="throwsIndent" value="4"/>
            <property name="lineWrappingIndentation" value="4"/>
            <property name="arrayInitIndent" value="2"/>
        </module>
        -->
        <module name="ArrayTypeStyle"/>
        <module name="MagicNumber"/>     
        <module name="TodoComment"/>
        <module name="UpperEll"/>
        <module name="ParameterNumber">        
            <property name="max" value="5"/>                
        </module>
        <module name="MethodLength">    
            <property name="max" value="300"/>                   
        </module>           
        <!--- 字符串比较必须使用 equals() -->     
        <module name="StringLiteralEquality"/>       
        <!-- if-else嵌套语句个数 最多4层 -->  
        <module name="NestedIfDepth">          
            <property name="max" value="3"/>           
        </module>       
        <!-- try-catch 嵌套语句个数 最多2层 -->  
        <module name="NestedTryDepth">    
            <property name="max" value="2"/>           
        </module>    
        <!-- 返回个数 -->     
        <module name="ReturnCount">          
            <property name="max" value="5"/>    
            <property name="format" value="^$"/>            
        </module>   
        <module name="AvoidEscapedUnicodeCharacters">
            <property name="allowEscapesForControlCharacters" value="true"/>
            <property name="allowByTailComment" value="true"/>
            <property name="allowNonPrintableEscapes" value="true"/>
        </module>
        <module name="OneStatementPerLine"/>
        <module name="MultipleVariableDeclarations"/>
        <module name="NoFinalizer"/>
        <module name="OverloadMethodsDeclarationOrder"/>
        <module name="AnnotationLocation">
            <property name="id" value="AnnotationLocationMostCases"/>
            <property name="tokens" value="CLASS_DEF, INTERFACE_DEF, ENUM_DEF, METHOD_DEF, CTOR_DEF"/>
        </module>
        <module name="AnnotationLocation">
            <property name="id" value="AnnotationLocationVariables"/>
            <property name="tokens" value="VARIABLE_DEF"/>
            <property name="allowSamelineMultipleAnnotations" value="true"/>
        </module>
        <module name="EmptyCatchBlock">
            <property name="exceptionVariableName" value="expected"/>
        </module>
    </module>
</module>