checkstyle教程：checkstyle.xml配置示例及中文解释

ゝ一世哀愁。 2023-10-16 12:58 22阅读 0赞

<?xml version="1.0"?>
    
    
    <!DOCTYPE module PUBLIC "-//Puppy Crawl//DTD Check Configuration 1.3//EN"
            "http://checkstyle.sourceforge.net/dtds/configuration_1_3.dtd">
    <module name="Checker">
        <property name="charset" value="UTF-8"/>
        <property name="severity" value="error"/>
        <property name="fileExtensions" value="java, properties, xml"/>
        <module name="Header">
            
            <property name="fileExtensions" value="java"/>
        </module>
        
        <module name="FileTabCharacter">
            <property name="eachLine" value="true"/>
        </module>
        
        <module name="FileLength">
            <property name="max" value="1500"/>
        </module>
        
        <module name="NewlineAtEndOfFile">
            <property name="lineSeparator" value="lf"/>
        </module>
        
        <module name="Translation"/>
        <module name="UniqueProperties"/>
    
        <module name="SeverityMatchFilter"/>
        
        <module name="TreeWalker">
            
            
            <module name="PackageName">
                <property name="format" value="^[a-z]+(\.[a-z][a-z0-9]*)*$"/>
                <message key="name.invalidPattern" value="包名 ''{0}'' 要符合 ''{1}''格式."/>
            </module>
            
            <module name="TypeName">
                <property name="severity" value="warning"/>
                <message key="name.invalidPattern" value="名称 ''{0}'' 要符合 ''{1}''格式."/>
            </module>
            
            <module name="MethodName"/>
            
            <module name="InterfaceTypeParameterName"/>
            
            <module name="ClassTypeParameterName"/>
            
            <module name="MethodTypeParameterName"/>
            
            <module name="ConstantName"/>
            
            <module name="StaticVariableName"/>
            
            <module name="MemberName"/>
            
            <module name="LocalVariableName"/>
            
            <module name="LocalFinalVariableName"/>
            
            <module name="ParameterName"/>
            
            <module name="CatchParameterName"/>
            
            <module name="AbbreviationAsWordInName">
                
                <property name="allowedAbbreviationLength" value="6"/>
            </module>
    
            
            
            <module name="AnonInnerLength"/>
            
            <module name="MethodLength"/>
            
            <module name="LineLength">
                <property name="max" value="200"/>
            </module>
            
            <module name="OuterTypeNumber"/>
    
            
            <module name="EmptyForInitializerPad"/>
            
            <module name="EmptyForIteratorPad"/>
            
            <module name="MethodParamPad"/>
            
            <module name="ParenPad"/>
            
            <module name="TypecastParenPad"/>
            
            <module name="NoLineWrap"/>
            
            <module name="OperatorWrap"/>
            
            <module name="SeparatorWrap">
                <property name="id" value="SeparatorWrapDot"/>
                <property name="tokens" value="DOT"/>
                <property name="option" value="nl"/>
            </module>
            <module name="SeparatorWrap">
                <property name="id" value="SeparatorWrapComma"/>
                <property name="tokens" value="COMMA"/>
                <property name="option" value="EOL"/>
            </module>
            <module name="SeparatorWrap">
                <property name="id" value="SeparatorWrapEllipsis"/>
                <property name="tokens" value="ELLIPSIS"/>
                <property name="option" value="EOL"/>
            </module>
            <module name="SeparatorWrap">
                <property name="id" value="SeparatorWrapArrayDeclarator"/>
                <property name="tokens" value="ARRAY_DECLARATOR"/>
                <property name="option" value="EOL"/>
            </module>
            <module name="SeparatorWrap">
                <property name="id" value="SeparatorWrapMethodRef"/>
                <property name="tokens" value="METHOD_REF"/>
                <property name="option" value="nl"/>
            </module>
            
            <module name="GenericWhitespace"/>
            
            <module name="NoWhitespaceBefore"/>
            
            <module name="NoWhitespaceAfter"/>
            
            <module name="WhitespaceAround"/>
            
            <module name="WhitespaceAfter"/>
            
            <module name="SingleSpaceSeparator"/>
            
            <module name="EmptyLineSeparator">
                
                <property name="allowMultipleEmptyLines" value="false"/>
                
                <property name="allowMultipleEmptyLinesInsideClassMembers" value="false"/>
            </module>
    
            
            
            <module name="AvoidStarImport"/>
            
            <module name="AvoidStaticImport">
                <property name="excludes"
                          value="org.junit.Assert.*,org.hamcrest.CoreMatchers.*,org.mockito.Mockito.*,org.mockito.ArgumentMatchers.*"/>
            </module>
            
            <module name="IllegalImport"/>
            
            <module name="RedundantImport"/>
            
            <module name="UnusedImports"/>
            
            <module name="CustomImportOrder"/>
    
            
            <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="AnnotationUseStyle"/>
            
            <module name="MissingOverride"/>
            
            <module name="SuppressWarnings"/>
            
            <module name="MissingDeprecated"/>
            
            <module name="SuppressWarningsHolder"/>
    
            
            
            <module name="ModifierOrder"/>
            
            <module name="RedundantModifier"/>
    
            
            
            <module name="ArrayTrailingComma"/>
            
            <module name="CovariantEquals"/>
            
            <module name="DefaultComesLast"/>
            
            <module name="DeclarationOrder"/>
            
            <module name="EmptyStatement"/>
            
            <module name="EqualsAvoidNull"/>
            
            <module name="ExplicitInitialization"/>
            
            <module name="FallThrough"/>
            
            <module name="IllegalInstantiation"/>
            
            <module name="IllegalCatch">
                
                <property name="illegalClassNames" value="Error,Throwable,java.lang.Error,java.lang.Throwable"/>
            </module>
            
            <module name="IllegalThrows"/>
            
            <module name="IllegalType">
                
                <property name="tokens" value="METHOD_DEF,PARAMETER_DEF,VARIABLE_DEF"/>
            </module>
            
            <module name="IllegalTokenText">
                <property name="tokens" value="STRING_LITERAL, CHAR_LITERAL"/>
                <property name="format"
                          value="\\u00(09|0(a|A)|0(c|C)|0(d|D)|22|27|5(C|c))|\\(0(10|11|12|14|15|42|47)|134)"/>
                <property name="message"
                          value="考虑使用特殊转义序列来代替八进制值或Unicode转义值."/>
            </module>
            
            <module name="MissingSwitchDefault"/>
            
            <module name="ModifiedControlVariable"/>
            
            <module name="MultipleVariableDeclarations"/>
            
            <module name="NestedIfDepth">
                <property name="max" value="3"/>
            </module>
            
            <module name="NestedTryDepth"/>
            
            <module name="NoClone"/>
            
            <module name="NoFinalizer"/>
            
            <module name="SuperClone"/>
            
            <module name="SuperFinalize"/>
            
            <module name="OneStatementPerLine"/>
            
            <module name="OverloadMethodsDeclarationOrder"/>
            
            <module name="PackageDeclaration"/>
            
            <module name="ParameterAssignment"/>
            
            <module name="SimplifyBooleanExpression"/>
            
            <module name="SimplifyBooleanReturn"/>
            
            <module name="StringLiteralEquality"/>
            
            <module name="UnnecessaryParentheses"/>
            
            <module name="VariableDeclarationUsageDistance"/>
    
            
            
            <module name="EmptyBlock"/>
            
            <module name="EmptyCatchBlock">
                
                <property name="exceptionVariableName" value="expected|ignore"/>
            </module>
            
            <module name="AvoidNestedBlocks"/>
            
            <module name="NeedBraces"/>
            
            <module name="LeftCurly"/>
            
            <module name="RightCurly"/>
    
            
            
            <module name="FinalClass"/>
            
            
            
            <module name="OneTopLevelClass"/>
            
            <module name="InterfaceIsType"/>
            
            <module name="InnerTypeLast"/>
            
            <module name="VisibilityModifier"/>
            
            <module name="MutableException"/>
            
            <module name="ThrowsCount"/>
    
            
            
            <module name="ArrayTypeStyle"/>
            
            <module name="UpperEll"/>
            
            <module name="AvoidEscapedUnicodeCharacters"/>
            
            <module name="DescendantToken"/>
            
    
            
            <module name="Indentation"/>
            
            <module name="OuterTypeFilename"/>
            
            <module name="TodoComment"/>
            
            <module name="TrailingComment"/>
    
            
            
            <module name="AtclauseOrder">
                <property name="tagOrder" value="@param, @return, @throws, @deprecated"/>
            </module>
            
            <module name="NonEmptyAtclauseDescription"/>
            
            <module name="JavadocParagraph"/>
            
            <module name="JavadocStyle"/>
            
            <module name="JavadocTagContinuationIndentation"/>
            
            <module name="SingleLineJavadoc"/>
    
            
            <module name="JavadocMethod">
                <property name="scope" value="public"/>
                <property name="allowedAnnotations"
                          value="Override, Test, Before, After, BeforeClass, AfterClass, Parameterized, Parameters"/>
                <property name="ignoreMethodNamesRegex" value="^assert.*$|^verify.*$"/>
                <property name="tokens" value="METHOD_DEF, ANNOTATION_FIELD_DEF"/>
            </module>
    
            
            <module name="SuppressionCommentFilter"/>
            <module name="SuppressWithNearbyCommentFilter"/>
        </module>
    </module>

--------------------

links：

[https://ld246.com/article/1613814037505][https_ld246.com_article_1613814037505]

[https_ld246.com_article_1613814037505]: https://ld246.com/article/1613814037505