style.xml

<?xml version="1.0"?>
<!DOCTYPE module PUBLIC
        "-//Checkstyle//DTD Checkstyle Configuration 1.3//EN"
        "https://checkstyle.org/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.org (or in your downloaded distribution).

    To completely disable a check, just comment it out or delete it from the file.
    To suppress certain violations please review suppression filters.

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

<module name="Checker">
    <!-- 检查器配置 -->

    <property name="charset" value="UTF-8"/>
    <!-- 字符集 -->

    <property name="severity" value="${org.checkstyle.google.severity}" default="warning"/>
    <!-- 严重性级别 -->

    <property name="fileExtensions" value="java, properties, xml"/>
    <!-- 文件扩展名 -->
    <!-- Excludes all 'module-info.java' files              -->
    <!-- See https://checkstyle.org/filefilters/index.html -->
    <module name="BeforeExecutionExclusionFileFilter">
        <!-- 排除执行前过滤器 -->
        <property name="fileNamePattern" value="module\-info\.java$"/>
        <!-- 文件名模式 -->
    </module>

    <module name="SuppressWarningsFilter"/>
    <!-- 抑制警告过滤器 -->

    <!-- https://checkstyle.org/filters/suppressionfilter.html -->
    <module name="SuppressionFilter">
        <!-- 抑制过滤器 -->
        <property name="file" value="${org.checkstyle.google.suppressionfilter.config}"
                  default="checkstyle-suppressions.xml" />
        <!-- 抑制文件路径 -->
        <property name="optional" value="true"/>
        <!-- 可选 -->
    </module>

    <!-- https://checkstyle.org/filters/suppresswithnearbytextfilter.html -->
    <module name="SuppressWithNearbyTextFilter">
        <!-- 附近文本抑制过滤器 -->
        <property name="nearbyTextPattern"
                  value="CHECKSTYLE.SUPPRESS\: (\w+) for ([+-]\d+) lines"/>
        <!-- 附近文本模式 -->
        <property name="checkPattern" value="$1"/>
        <!-- 检查模式 -->
        <property name="lineRange" value="$2"/>
        <!-- 行范围 -->
    </module>

    <!-- Checks for whitespace                               -->
    <!-- See http://checkstyle.org/checks/whitespace/index.html -->
    <module name="FileTabCharacter">
        <!-- 文件制表符检查 -->
        <property name="eachLine" value="true"/>
        <!-- 每行检查 -->
    </module>

    <module name="LineLength">
        <!-- 行长度检查 -->
        <property name="fileExtensions" value="java"/>
        <!-- 文件扩展名 -->
        <property name="max" value="140"/>
        <!-- 最大长度 -->
        <property name="ignorePattern"
                  value="^package.*|^import.*|href\s*=\s*&quot;[^&quot;]*&quot;|http://|https://|ftp://"/>
        <!-- 忽略模式 -->
    </module>
    <!--  Suppression to prevent LineLength Check from flagging lines in Text-blocks -->
    <module name="SuppressWithPlainTextCommentFilter">
        <!-- 纯文本注释抑制过滤器 -->
        <property name="checkFormat" value="LineLength"/>
        <!-- 检查格式 -->
        <property name="offCommentFormat" value='^.*"""\s*$'/>
        <!-- 关闭注释格式 -->
        <property name="onCommentFormat" value='^\s*"""\s*(?:[,;]|.+)$'/>
        <!-- 打开注释格式 -->
    </module>
    <module name="TreeWalker">
        <!-- 树遍历器 -->
        <module name="OuterTypeFilename"/>
        <!-- 外部类型文件名检查 -->
        <module name="RequireThis"/>
        <!-- 需要 THIS -->
        <module name="MatchXpath">
            <!-- XPath匹配 -->
            <property name="id" value="singleLineCommentStartWithSpace"/>
            <!-- ID -->
            <property name="query"
                      value="//SINGLE_LINE_COMMENT[./COMMENT_CONTENT[not(starts-with(@text, ' '))
                       and not(starts-with(@text, '/'))
                       and not(@text = '\n') and not(ends-with(@text, '//\n'))]]"/>
            <!-- 查询 -->
            <message key="matchxpath.match" value="''//'' must be followed by a whitespace.''//''后面必须跟一个空格。"/>
        </module>
        <module name="IllegalTokenText">
            <!-- 非法令牌文本 -->
            <property name="tokens" value="STRING_LITERAL, CHAR_LITERAL, TEXT_BLOCK_CONTENT"/>
            <!-- 令牌 -->
            <property name="format"
                      value="\\u00(09|0(a|A)|0(b|B)|(0|1)(c|C)|(0|1)(d|D)|1(d|D)|1(e|E)|1(f|F)|22|27|5(C|c))|\\u1680|\\u3000|\\u20(00|0(a|A)|28|29|(2|5)(f|F))|\\(0(10|11|12|14|15|40|42|47)|134)"/>
            <!-- 格式 -->
            <property name="message"
                      value="Consider using special escape sequence instead of octal value or Unicode escaped value.考虑使用特殊的转义序列而不是八进制值或Unicode转义值。"/>
        </module>
        <module name="AvoidEscapedUnicodeCharacters">
            <!-- 避免转义Unicode字符 -->
            <property name="allowEscapesForControlCharacters" value="true"/>
            <!-- 允许控制字符转义 -->
            <property name="allowByTailComment" value="true"/>
            <!-- 允许尾部注释 -->
            <property name="allowNonPrintableEscapes" value="true"/>
            <!-- 允许不可打印转义 -->
        </module>
        <module name="AvoidStarImport"/>
        <!-- 避免星号导入 -->
        <module name="OneTopLevelClass"/>
        <!-- 一个顶级类 -->
        <module name="NoLineWrap">
            <!-- 禁止换行 -->
            <property name="tokens" value="PACKAGE_DEF, IMPORT, STATIC_IMPORT"/>
            <!-- 令牌 -->
        </module>
        <module name="NeedBraces">
            <!-- 需要大括号 -->
            <property name="tokens"
                      value="LITERAL_DO, LITERAL_ELSE, LITERAL_FOR, LITERAL_IF, LITERAL_WHILE"/>
            <property name="allowSingleLineStatement" value="true"/>
            <!-- 令牌 -->
        </module>
        <module name="LeftCurly">
            <!-- 左花括号 -->
            <property name="id" value="LeftCurlyEol"/>
            <!-- ID -->
            <property name="tokens"
                      value="ANNOTATION_DEF, CLASS_DEF, CTOR_DEF, ENUM_CONSTANT_DEF, ENUM_DEF,
                    INTERFACE_DEF, LAMBDA, LITERAL_CATCH,
                    LITERAL_DO, LITERAL_ELSE, LITERAL_FINALLY, LITERAL_FOR, LITERAL_IF,
                    LITERAL_SWITCH, LITERAL_SYNCHRONIZED, LITERAL_TRY, LITERAL_WHILE, METHOD_DEF,
                    OBJBLOCK, STATIC_INIT, RECORD_DEF, COMPACT_CTOR_DEF"/>
            <!-- 令牌 -->
        </module>
        <module name="LeftCurly">
            <!-- 左花括号 -->
            <property name="id" value="LeftCurlyNl"/>
            <!-- ID -->
            <property name="option" value="nl"/>
            <!-- 选项 -->
            <property name="tokens"
                      value="LITERAL_CASE, LITERAL_DEFAULT"/>
            <!-- 令牌 -->
        </module>
        <module name="SuppressionXpathSingleFilter">
            <!-- LITERAL_CASE, LITERAL_DEFAULT are reused in SWITCH_RULE  -->
            <!-- 单一XPath抑制过滤器 -->
            <property name="id" value="LeftCurlyNl"/>
            <!-- ID -->
            <property name="query" value="//SWITCH_RULE/SLIST"/>
            <!-- 查询 -->
        </module>
        <module name="RightCurly">
            <!-- 右花括号 -->
            <property name="id" value="RightCurlySame"/>
            <!-- ID -->
            <property name="tokens"
                      value="LITERAL_TRY, LITERAL_CATCH, LITERAL_IF, LITERAL_ELSE,
                    LITERAL_DO"/>
            <!-- 令牌 -->
        </module>
        <module name="SuppressionXpathSingleFilter">
            <!-- 单一XPath抑制过滤器 -->
            <property name="id" value="RightCurlySame"/>
            <!-- ID -->
            <property name="query" value="//RCURLY[parent::SLIST[parent::LITERAL_CATCH
                               and not(parent::LITERAL_CATCH/following-sibling::*)]]"/>
            <!-- 查询 -->
        </module>
        <module name="RightCurly">
            <!-- 右花括号 -->
            <property name="id" value="RightCurlyAlone"/>
            <!-- ID -->
            <property name="option" value="alone"/>
            <!-- 选项 -->
            <property name="tokens"
                      value="CLASS_DEF, METHOD_DEF, CTOR_DEF, LITERAL_FOR, LITERAL_WHILE, STATIC_INIT,
                    INSTANCE_INIT, ANNOTATION_DEF, ENUM_DEF, INTERFACE_DEF, RECORD_DEF,
                    COMPACT_CTOR_DEF, LITERAL_SWITCH, LITERAL_CASE, LITERAL_FINALLY,
                    LITERAL_CATCH"/>
            <!-- 令牌 -->
        </module>
        <module name="SuppressionXpathSingleFilter">
            <!-- suppression is required till https://github.com/checkstyle/checkstyle/issues/7541 -->
            <!-- 单一XPath抑制过滤器 -->
            <property name="id" value="RightCurlyAlone"/>
            <!-- ID -->
            <property name="query" value="//RCURLY[parent::SLIST[count(./*)=1
                               and not(parent::LITERAL_CATCH)]
                               or (preceding-sibling::*[last()][self::LCURLY]
                               and not(parent::SLIST/parent::LITERAL_CATCH))
                               or (parent::SLIST/parent::LITERAL_CATCH
                               and parent::SLIST/parent::LITERAL_CATCH/following-sibling::*)]"/>
            <!-- 查询 -->
        </module>
        <module name="WhitespaceAfter">
            <!-- 空格后 -->
            <property name="tokens"
                      value="COMMA, SEMI, TYPECAST, LITERAL_IF, LITERAL_ELSE, LITERAL_RETURN,
                    LITERAL_WHILE, LITERAL_DO, LITERAL_FOR, LITERAL_FINALLY, DO_WHILE, ELLIPSIS,
                    LITERAL_SWITCH, LITERAL_SYNCHRONIZED, LITERAL_TRY, LITERAL_CATCH, LAMBDA,
                    LITERAL_YIELD, LITERAL_CASE, LITERAL_WHEN"/>
            <!-- 令牌 -->
        </module>
        <module name="WhitespaceAround">
            <!-- 周围空格 -->
            <property name="allowEmptyConstructors" value="true"/>
            <!-- 允许空构造函数 -->
            <property name="allowEmptyLambdas" value="true"/>
            <!-- 允许空Lambda表达式 -->
            <property name="allowEmptyMethods" value="true"/>
            <!-- 允许空方法 -->
            <property name="allowEmptyTypes" value="true"/>
            <!-- 允许空类型 -->
            <property name="allowEmptyLoops" value="true"/>
            <!-- 允许空循环 -->
            <property name="allowEmptySwitchBlockStatements" value="true"/>
            <!-- 允许空switch块语句 -->
            <property name="ignoreEnhancedForColon" value="false"/>
            <!-- 忽略增强for循环冒号 -->
            <property name="tokens"
                      value="ASSIGN, BAND, BAND_ASSIGN, BOR, BOR_ASSIGN, BSR, BSR_ASSIGN, BXOR,
                    BXOR_ASSIGN, COLON, DIV, DIV_ASSIGN, DO_WHILE, EQUAL, GE, GT, LAMBDA, LAND,
                    LCURLY, LE, LITERAL_CATCH, LITERAL_DO, LITERAL_ELSE, LITERAL_FINALLY,
                    LITERAL_FOR, LITERAL_IF, LITERAL_RETURN, LITERAL_SWITCH, LITERAL_SYNCHRONIZED,
                    LITERAL_TRY, LITERAL_WHILE, LOR, LT, MINUS, MINUS_ASSIGN, MOD, MOD_ASSIGN,
                    NOT_EQUAL, PLUS, PLUS_ASSIGN, QUESTION, RCURLY, SL, SLIST, SL_ASSIGN, SR,
                    SR_ASSIGN, STAR, STAR_ASSIGN, LITERAL_ASSERT,
                    TYPE_EXTENSION_AND, LITERAL_WHEN"/>
            <!-- 令牌 -->
            <message key="ws.notFollowed"
                     value="WhitespaceAround: ''{0}'' is not followed by whitespace. Empty blocks
               may only be represented as '{}' when not part of a multi-block statement (4.1.3)周围空格：''{0}''后面没有空格。空块只有在不作为多块语句的一部分时才能表示为'{}'（4.1.3）"/>
            <message key="ws.notPreceded"
                     value="WhitespaceAround: ''{0}'' is not preceded with whitespace.周围空格：''{0}''前面没有空格。"/>
        </module>
        <module name="SuppressionXpathSingleFilter">
            <!-- 单一XPath抑制过滤器 -->
            <property name="checks" value="WhitespaceAround"/>
            <!-- 检查 -->
            <property name="query" value="//*[self::LITERAL_IF or self::LITERAL_ELSE or
                                 self::STATIC_INIT]/SLIST[count(./*)=1]
                                 | //*[self::STATIC_INIT or self::LITERAL_TRY or self::LITERAL_IF]
                                 //*[self::RCURLY][parent::SLIST[count(./*)=1]]
                                 | //SLIST[count(./*)=1][parent::LITERAL_TRY and
                                 not(following-sibling::*)]
                                 | //SLIST[count(./*)=1][parent::LITERAL_CATCH and
                                 not(parent::LITERAL_CATCH/following-sibling::*)]"/>
            <!-- 查询 -->
        </module>
        <module name="RegexpSinglelineJava">
            <!-- 正则表达式单行Java -->
            <property name="format" value="\{[ ]+\}"/>
            <!-- 格式 -->
            <property name="message" value="Empty blocks should have no spaces. Empty blocks
                                   may only be represented as '{}' when not part of a
                                   multi-block statement (4.1.3)空块不应该有空格。空块只有在不作为多块语句的一部分时才能表示为'{}'（4.1.3）"/>
        </module>
        <module name="OneStatementPerLine"/>
        <!-- 每行一个语句 -->
        <module name="MultipleVariableDeclarations"/>
        <!-- 多变量声明 -->
        <module name="ArrayTypeStyle"/>
        <!-- 数组类型风格 -->
        <module name="JavadocLeadingAsteriskAlign"/>
        <!-- Javadoc前导星号对齐 -->
        <module name="MissingSwitchDefault"/>
        <!-- 缺少switch默认分支 -->
        <module name="FallThrough"/>
        <!-- 贯穿 -->
        <module name="UpperEll"/>
        <!-- 大写L -->
        <module name="ModifierOrder"/>
        <!-- 修饰符顺序 -->
        <module name="EmptyLineSeparator">
            <!-- 空行分隔符 -->
            <property name="tokens"
                      value="PACKAGE_DEF, IMPORT, STATIC_IMPORT, CLASS_DEF, INTERFACE_DEF, ENUM_DEF,
                    STATIC_INIT, INSTANCE_INIT, METHOD_DEF, CTOR_DEF, VARIABLE_DEF, RECORD_DEF,
                    COMPACT_CTOR_DEF"/>
            <!-- 令牌 -->
            <property name="allowNoEmptyLineBetweenFields" value="true"/>
            <!-- 允许字段之间无空行 -->
            <property name="allowMultipleEmptyLines" value="false"/>
            <!-- 不允许多个空行 -->
        </module>
        <module name="SeparatorWrap">
            <!-- 分隔符包装 -->
            <property name="id" value="SeparatorWrapDot"/>
            <!-- ID -->
            <property name="tokens" value="DOT"/>
            <!-- 令牌 -->
            <property name="option" value="nl"/>
            <!-- 选项 -->
        </module>
        <module name="SeparatorWrap">
            <!-- 分隔符包装 -->
            <property name="id" value="SeparatorWrapComma"/>
            <!-- ID -->
            <property name="tokens" value="COMMA"/>
            <!-- 令牌 -->
            <property name="option" value="EOL"/>
            <!-- 选项 -->
        </module>
        <module name="SeparatorWrap">
            <!-- ELLIPSIS is EOL until https://github.com/google/styleguide/issues/259 -->
            <!-- 分隔符包装 -->
            <property name="id" value="SeparatorWrapEllipsis"/>
            <!-- ID -->
            <property name="tokens" value="ELLIPSIS"/>
            <!-- 令牌 -->
            <property name="option" value="EOL"/>
            <!-- 选项 -->
        </module>
        <module name="SeparatorWrap">
            <!-- ARRAY_DECLARATOR is EOL until https://github.com/google/styleguide/issues/258 -->
            <!-- 分隔符包装 -->
            <property name="id" value="SeparatorWrapArrayDeclarator"/>
            <!-- ID -->
            <property name="tokens" value="ARRAY_DECLARATOR"/>
            <!-- 令牌 -->
            <property name="option" value="EOL"/>
            <!-- 选项 -->
        </module>
        <module name="SeparatorWrap">
            <!-- 分隔符包装 -->
            <property name="id" value="SeparatorWrapMethodRef"/>
            <!-- ID -->
            <property name="tokens" value="METHOD_REF"/>
            <!-- 令牌 -->
            <property name="option" value="nl"/>
            <!-- 选项 -->
        </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}''.包名''{0}''必须匹配模式''{1}''。"/>
        </module>
        <module name="TypeName">
            <!-- 类型名 -->
            <property name="format" value="^[A-Z][a-zA-Z0-9]*(?:[0-9](?:_[0-9]+)*)?$"/>
            <!-- 格式 -->
            <property name="tokens" value="CLASS_DEF"/>
            <!-- 令牌 -->
            <message key="name.invalidPattern"
                     value="Type name ''{0}'' must match pattern ''{1}''.类型名''{0}''必须匹配模式''{1}''。"/>
        </module>
        <module name="TypeName">
            <!-- 类型名 -->
            <property name="tokens" value="INTERFACE_DEF, ENUM_DEF,
                    ANNOTATION_DEF, RECORD_DEF"/>
            <!-- 令牌 -->
            <message key="name.invalidPattern"
                     value="Type name ''{0}'' must match pattern ''{1}''.类型名''{0}''必须匹配模式''{1}''。"/>
        </module>
        <module name="MemberName">
            <!-- 成员名 -->
            <property name="format"
                      value="^(?![a-z]$)(?![a-z][A-Z])[a-z][a-zA-Z0-9$]*(?:_[0-9]+)*$"/>
            <!-- 格式 -->
            <message key="name.invalidPattern"
                     value="Member name ''{0}'' must match pattern ''{1}''.成员名''{0}''必须匹配模式''{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}''.参数名''{0}''必须匹配模式''{1}''。"/>
        </module>
        <module name="LambdaParameterName">
            <!-- Lambda参数名 -->
            <property name="format" value="^[a-z]([a-z0-9][a-zA-Z0-9]*)?$"/>
            <!-- 格式 -->
            <message key="name.invalidPattern"
                     value="Lambda parameter name ''{0}'' must match pattern ''{1}''.Lambda参数名''{0}''必须匹配模式''{1}''。"/>
        </module>
        <module name="CatchParameterName">
            <!-- Catch参数名 -->
            <property name="format" value="^[a-z]([a-z0-9][a-zA-Z0-9]*)?$"/>
            <!-- 格式 -->
            <message key="name.invalidPattern"
                     value="Catch parameter name ''{0}'' must match pattern ''{1}''.Catch参数名''{0}''必须匹配模式''{1}''。"/>
        </module>
        <module name="LocalVariableName">
            <!-- 局部变量名 -->
            <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}''.局部变量名''{0}''必须匹配模式''{1}''。"/>
        </module>
        <module name="PatternVariableName">
            <!-- 模式变量名 -->
            <property name="format" value="^[a-z]([a-z0-9][a-zA-Z0-9]*)?$"/>
            <!-- 格式 -->
            <message key="name.invalidPattern"
                     value="Pattern variable name ''{0}'' must match pattern ''{1}''.模式变量名''{0}''必须匹配模式''{1}''。"/>
        </module>
        <module name="ClassTypeParameterName">
            <!-- 类型参数名 -->
            <property name="format" value="(^[A-Z][0-9]?)$|([A-Z][a-zA-Z0-9]*[T]$)"/>
            <!-- 格式 -->
            <message key="name.invalidPattern"
                     value="Class type name ''{0}'' must match pattern ''{1}''.类类型名''{0}''必须匹配模式''{1}''。"/>
        </module>
        <module name="RecordComponentName">
            <!-- 记录组件名 -->
            <property name="format" value="^[a-z]([a-z0-9][a-zA-Z0-9]*)?$"/>
            <!-- 格式 -->
            <message key="name.invalidPattern"
                     value="Record component name ''{0}'' must match pattern ''{1}''.记录组件名''{0}''必须匹配模式''{1}''。"/>
        </module>
        <module name="RecordTypeParameterName">
            <!-- 记录类型参数名 -->
            <property name="format" value="(^[A-Z][0-9]?)$|([A-Z][a-zA-Z0-9]*[T]$)"/>
            <!-- 格式 -->
            <message key="name.invalidPattern"
                     value="Record type name ''{0}'' must match pattern ''{1}''.记录类型名''{0}''必须匹配模式''{1}''。"/>
        </module>
        <module name="MethodTypeParameterName">
            <!-- 方法类型参数名 -->
            <property name="format" value="(^[A-Z][0-9]?)$|([A-Z][a-zA-Z0-9]*[T]$)"/>
            <!-- 格式 -->
            <message key="name.invalidPattern"
                     value="Method type name ''{0}'' must match pattern ''{1}''.方法类型名''{0}''必须匹配模式''{1}''。"/>
        </module>
        <module name="InterfaceTypeParameterName">
            <!-- 接口类型参数名 -->
            <property name="format" value="(^[A-Z][0-9]?)$|([A-Z][a-zA-Z0-9]*[T]$)"/>
            <!-- 格式 -->
            <message key="name.invalidPattern"
                     value="Interface type name ''{0}'' must match pattern ''{1}''.接口类型名''{0}''必须匹配模式''{1}''。"/>
        </module>
        <module name="NoFinalizer"/>
        <!-- 无终结器 -->
        <module name="GenericWhitespace">
            <!-- 泛型空白 -->
            <message key="ws.followed"
                     value="GenericWhitespace ''{0}'' is followed by whitespace.泛型空白''{0}''后面跟了空格。"/>
            <message key="ws.preceded"
                     value="GenericWhitespace ''{0}'' is preceded with whitespace.泛型空白''{0}''前面有空格。"/>
            <message key="ws.illegalFollow"
                     value="GenericWhitespace ''{0}'' should followed by whitespace.泛型空白''{0}''应该后面跟空格。"/>
            <message key="ws.notPreceded"
                     value="GenericWhitespace ''{0}'' is not preceded with whitespace.泛型空白''{0}''前面没有空格。"/>
        </module>
        <module name="Indentation">
            <!-- 缩进 -->
            <property name="basicOffset" value="4"/>
            <!-- 基本偏移量 -->
            <property name="braceAdjustment" value="4"/>
            <!-- 大括号调整 -->
            <property name="caseIndent" value="4"/>
            <!-- case缩进 -->
            <property name="throwsIndent" value="4"/>
            <!-- throws缩进 -->
            <property name="lineWrappingIndentation" value="0"/>
            <!-- 换行缩进 -->
            <property name="arrayInitIndent" value="4"/>
            <!-- 数组初始化缩进 -->
        </module>

        <module name="AbbreviationAsWordInName">
            <!-- 名称中的缩写 -->
            <property name="ignoreFinal" value="false"/>
            <!-- 忽略final -->
            <property name="allowedAbbreviationLength" value="3"/>
            <!-- 允许的缩写长度 -->
            <property name="tokens"
                      value="CLASS_DEF, INTERFACE_DEF, ENUM_DEF, ANNOTATION_DEF, ANNOTATION_FIELD_DEF,
                    PARAMETER_DEF, VARIABLE_DEF, METHOD_DEF, PATTERN_VARIABLE_DEF, RECORD_DEF,
                    RECORD_COMPONENT_DEF"/>
            <!-- 令牌 -->
        </module>
        <module name="NoWhitespaceBeforeCaseDefaultColon"/>
        <!-- case/default冒号前无空格 -->
        <module name="OverloadMethodsDeclarationOrder"/>
        <!-- 重载方法声明顺序 -->
        <module name="ConstructorsDeclarationGrouping"/>
        <!-- 构造函数声明分组 -->
        <module name="VariableDeclarationUsageDistance"/>
        <!-- 变量声明使用距离 -->
        <module name="CustomImportOrder">
            <!-- 自定义导入顺序 -->
            <property name="sortImportsInGroupAlphabetically" value="true"/>
            <!-- 组内按字母顺序排序导入 -->
            <property name="separateLineBetweenGroups" value="true"/>
            <!-- 组间用空行分隔 -->
            <property name="customImportOrderRules" value="THIRD_PARTY_PACKAGE, STANDARD_JAVA_PACKAGE, STATIC"/>
            <!-- 自定义导入顺序规则 -->
            <property name="tokens" value="IMPORT, STATIC_IMPORT, PACKAGE_DEF"/>
            <!-- 令牌 -->
        </module>
        <module name="MethodParamPad">
            <!-- 方法参数填充 -->
            <property name="tokens"
                      value="CTOR_DEF, LITERAL_NEW, METHOD_CALL, METHOD_DEF, CTOR_CALL,
                    SUPER_CTOR_CALL, ENUM_CONSTANT_DEF, RECORD_DEF, RECORD_PATTERN_DEF"/>
            <!-- 令牌 -->
        </module>
        <module name="NoWhitespaceBefore">
            <!-- 前面无空格 -->
            <property name="tokens"
                      value="COMMA, SEMI, POST_INC, POST_DEC, DOT,
                    LABELED_STAT, METHOD_REF, ELLIPSIS"/>
            <!-- 令牌 -->
            <property name="allowLineBreaks" value="true"/>
            <!-- 允许换行 -->
        </module>
        <module name="SuppressionXpathSingleFilter">
            <!-- 单一XPath抑制过滤器 -->
            <property name="checks" value="NoWhitespaceBefore"/>
            <!-- 检查 -->
            <property name="query"
                      value="//ELLIPSIS[preceding-sibling::TYPE/ANNOTATIONS[ANNOTATION[LPAREN]
              or not(following-sibling::*)]]"/>
            <!-- 查询 -->
        </module>
        <module name="ParenPad">
            <!-- 括号填充 -->
            <property name="tokens"
                      value="ANNOTATION, ANNOTATION_FIELD_DEF, CTOR_CALL, CTOR_DEF, DOT, ENUM_CONSTANT_DEF,
                    EXPR, LITERAL_CATCH, LITERAL_DO, LITERAL_FOR, LITERAL_IF, LITERAL_NEW,
                    LITERAL_SWITCH, LITERAL_SYNCHRONIZED, LITERAL_WHILE, METHOD_CALL,
                    METHOD_DEF, QUESTION, RESOURCE_SPECIFICATION, SUPER_CTOR_CALL, LAMBDA,
                    RECORD_DEF, RECORD_PATTERN_DEF"/>
            <!-- 令牌 -->
        </module>
        <module name="OperatorWrap">
            <!-- 运算符换行 -->
            <property name="option" value="NL"/>
            <!-- 选项 -->
            <property name="tokens"
                      value="BAND, BOR, BSR, BXOR, DIV, EQUAL, GE, GT, LAND, LE, LITERAL_INSTANCEOF, LOR,
                    LT, MINUS, MOD, NOT_EQUAL, PLUS, QUESTION, SL, SR, STAR, METHOD_REF,
                    TYPE_EXTENSION_AND "/>
            <!-- 令牌 -->
        </module>
        <module name="AnnotationLocation">
            <!-- 注解位置 -->
            <property name="id" value="AnnotationLocationMostCases"/>
            <!-- ID -->
            <property name="tokens"
                      value="CLASS_DEF, INTERFACE_DEF, ENUM_DEF, METHOD_DEF, CTOR_DEF,
                      RECORD_DEF, COMPACT_CTOR_DEF, PACKAGE_DEF"/>
            <!-- 令牌 -->
        </module>
        <module name="AnnotationLocation">
            <!-- 注解位置 -->
            <property name="id" value="AnnotationLocationVariables"/>
            <!-- ID -->
            <property name="tokens" value="VARIABLE_DEF"/>
            <!-- 令牌 -->
            <property name="allowSamelineMultipleAnnotations" value="true"/>
            <!-- 允许同行多个注解 -->
        </module>
        <module name="NonEmptyAtclauseDescription"/>
        <!-- 非空@子句描述 -->
        <module name="InvalidJavadocPosition"/>
        <!-- 无效的Javadoc位置 -->
        <module name="JavadocTagContinuationIndentation"/>
        <!-- Javadoc标签延续缩进 -->
        <module name="SummaryJavadoc">
            <!-- 摘要Javadoc -->
            <property name="forbiddenSummaryFragments"
                      value="^@return the *|^This method returns |^A [{]@code [a-zA-Z0-9]+[}]( is a )"/>
            <property name="period" value=""/>
            <!-- 禁止的摘要片段 -->
        </module>
        <module name="JavadocParagraph">
            <!-- Javadoc段落 -->
            <property name="allowNewlineParagraph" value="true"/>
            <!-- 允许新段落换行 -->
        </module>
        <module name="RequireEmptyLineBeforeBlockTagGroup"/>
        <!-- 要求块标签组前有空行 -->
        <module name="AtclauseOrder">
            <!-- @子句顺序 -->
            <property name="tagOrder" value="@param, @return, @throws, @deprecated"/>
            <!-- 标签顺序 -->
            <property name="target"
                      value="CLASS_DEF, INTERFACE_DEF, ENUM_DEF, METHOD_DEF, CTOR_DEF, VARIABLE_DEF"/>
            <!-- 目标 -->
        </module>
        <module name="JavadocMethod">
            <!-- Javadoc方法 -->
            <property name="accessModifiers" value="public"/>
            <!-- 访问修饰符 -->
            <property name="allowMissingParamTags" value="true"/>
            <!-- 允许缺少参数标签 -->
            <property name="allowMissingReturnTag" value="true"/>
            <!-- 允许缺少返回标签 -->
            <property name="allowedAnnotations" value="Override, Test"/>
            <!-- 允许的注解 -->
            <property name="tokens" value="METHOD_DEF, CTOR_DEF, ANNOTATION_FIELD_DEF, COMPACT_CTOR_DEF"/>
            <!-- 令牌 -->
        </module>
        <!-- 注释掉Javadoc方法检查，不强制要求Javadoc -->
        <!--
        <module name="MissingJavadocMethod">
            <property name="scope" value="protected"/>
            <property name="allowMissingPropertyJavadoc" value="true"/>
            <property name="allowedAnnotations" value="Override, Test"/>
            <property name="tokens" value="METHOD_DEF, CTOR_DEF, ANNOTATION_FIELD_DEF,
                                   COMPACT_CTOR_DEF"/>
        </module>
        <module name="SuppressionXpathSingleFilter">
            <property name="checks" value="MissingJavadocMethod"/>
            <property name="query" value="//*[self::METHOD_DEF or self::CTOR_DEF
                                 or self::ANNOTATION_FIELD_DEF or self::COMPACT_CTOR_DEF]
                                 [ancestor::*[self::INTERFACE_DEF or self::CLASS_DEF
                                 or self::RECORD_DEF or self::ENUM_DEF]
                                 [not(./MODIFIERS/LITERAL_PUBLIC)]]"/>
        </module>
        -->
        <!--
        <module name="MissingJavadocType">
            <property name="scope" value="protected"/>
            <property name="tokens"
                      value="CLASS_DEF, INTERFACE_DEF, ENUM_DEF,
                      RECORD_DEF, ANNOTATION_DEF"/>
            <property name="excludeScope" value="nothing"/>
        </module>
        -->
        <module name="MethodName">
            <!-- 方法名 -->
            <property name="format"
                      value="^(?![a-z]$)(?![a-z][A-Z])[a-z][a-z0-9$]*(?:[A-Z][a-z0-9]*)*(?:_[0-9]+)*$"/>
            <!-- 格式 -->
            <message key="name.invalidPattern"
                     value="Method name ''{0}'' must match pattern ''{1}''.方法名''{0}''必须匹配模式''{1}''。"/>
        </module>
        <module name="SuppressionXpathSingleFilter">
            <!-- 单一XPath抑制过滤器 -->
            <property name="checks" value="MethodName"/>
            <!-- 检查 -->
            <property name="query" value="//METHOD_DEF[
                                     ./MODIFIERS/ANNOTATION//IDENT[contains(@text, 'Test')]
                                   ]/IDENT"/>
            <!-- 查询 -->
            <property name="message" value="'[a-z][a-z0-9][a-zA-Z0-9]*(?:_[a-z][a-z0-9][a-zA-Z0-9]*)*'"/>
        </module>
        <module name="SingleLineJavadoc"/>
        <!-- 单行Javadoc -->
        <module name="TodoComment">
            <!-- TODO注释 -->
            <property name="format" value="^[ \t]*(?!TODO:)(?i:TODO)\b:?"/>
            <!-- 格式 -->
            <message key="todo.match"
                     value="''TODO:'' must be written in all caps and followed by a colon.''TODO:''必须全部大写并后跟冒号。"/>
        </module>
        <module name="EmptyCatchBlock">
            <!-- 空Catch块 -->
            <property name="commentFormat" value="\w+"/>
            <!-- 注释格式 -->
        </module>
        <module name="CommentsIndentation">
            <!-- 注释缩进 -->
            <property name="tokens" value="SINGLE_LINE_COMMENT, BLOCK_COMMENT_BEGIN"/>
            <!-- 令牌 -->
        </module>
        <!-- https://checkstyle.org/filters/suppressionxpathfilter.html -->
        <module name="SuppressionXpathFilter">
            <!-- XPath抑制过滤器 -->
            <property name="file" value="${org.checkstyle.google.suppressionxpathfilter.config}"
                      default="checkstyle-xpath-suppressions.xml" />
            <!-- 文件 -->
            <property name="optional" value="true"/>
            <!-- 可选 -->
        </module>
        <module name="SuppressWarningsHolder" />
        <!-- 抑制警告持有者 -->
        <module name="SuppressionCommentFilter">
            <!-- 抑制注释过滤器 -->
            <property name="offCommentFormat" value="CHECKSTYLE.OFF\: ([\w\|]+)" />
            <!-- 关闭注释格式 -->
            <property name="onCommentFormat" value="CHECKSTYLE.ON\: ([\w\|]+)" />
            <!-- 打开注释格式 -->
            <property name="checkFormat" value="$1" />
            <!-- 检查格式 -->
        </module>
        <module name="SuppressWithNearbyCommentFilter">
            <!-- 附近注释抑制过滤器 -->
            <property name="commentFormat" value="CHECKSTYLE.SUPPRESS\: ([\w\|]+)"/>
            <!-- 注释格式 -->
            <!-- $1 refers to the first match group in the regex defined in commentFormat -->
            <!-- $1指注释格式中正则表达式定义的第一个匹配组 -->
            <property name="checkFormat" value="$1"/>
            <!-- 检查格式 -->
            <!-- The check is suppressed in the next line of code after the comment -->
            <!-- 检查在注释后的下一行代码中被抑制 -->
            <property name="influenceFormat" value="1"/>
            <!-- 影响格式 -->
        </module>
    </module>
</module>