CheckStyle

KO | EN

gitlite — search

#llm #go #machine-learning #deep-learning #linux #macos #nodejs #java #cli #vue #pytorch #security #mcp #openai

(★ 26)

在协同开发中让代码风格保持一致

CheckStyle 최신버젼 다운로드

최종 버전 다운로드 (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# 在多人协同开发中，保持代码风格一样是一件十分重要的事情，而checkstyle 可以帮助我们做到这一点

# 一. Checkstyle 可以做什么

1.注解检查
2.代码块检查
3.类检查
4.代码检查
5.文件头检查
6.导包检查
7.度量检查
8.命名规范检查

------

# 二. Checkstyle 配置规则

* 注解检查

```
        
        <module name="AnnotationLocation">
            <property name="allowSamelineMultipleAnnotations" value="false" />
            <property name="allowSamelineSingleParameterlessAnnotation" value="false" />
            <property name="allowSamelineParameterizedAnnotation" value="false" />
        </module>

<module name="AnnotationUseStyle">
            <property name="elementStyle" value="compact" />
            <property name="trailingArrayComma" value="never" />
            <property name="closingParens" value="never" />
        </module>

<module name="MissingDeprecated">
            <property name="skipNoJavadoc" value="false" />
        </module>

<module name="MissingOverride">
            <property name="javaFiveCompatibility" value="true" />
        </module>

<module name="PackageAnnotation" />

<module name="SuppressWarnings">
            <property name="format" value="^unchecked$|^unused$" />
            <property name="tokens" value="
          CLASS_DEF,INTERFACE_DEF,ENUM_DEF,
          ANNOTATION_DEF,ANNOTATION_FIELD_DEF,
          ENUM_CONSTANT_DEF,METHOD_DEF,CTOR_DEF
          " />
        </module>

```
 *  代码块检查

```
        <!--避免嵌套的代码块，如

public void guessTheOutput(){
                         int whichIsWhich = 0;
                         {
                              int whichIsWhich = 2;
                         }
                         System.out.println("value = " + whichIsWhich);
                     }

allowInSwitchCase  是允许switch-case中存在嵌套代码块，如

switch (a){
                        case 0:
                            // Never OK, break outside block
                            {
                                x = 1;
                            }
                            break;
                        case 1:
                            // Never OK, statement outside block
                            System.out.println("Hello");
                            {
                                x = 2;
                                break;
                            }
                        case 1:
                            // OK if allowInSwitchCase is true
                            {
                                System.out.println("Hello");
                                x = 2;
                                break;
                            }
                    }
        -->
        <module name="AvoidNestedBlocks">
            <property name="allowInSwitchCase" value="false" />
        </module>

<module name="EmptyBlock">
            <property name="option" value="stmt" />
        </module>

<module name="EmptyCatchBlock" />

<module name="LeftCurly">
            <property name="option" value="nlow" />
        </module>

<module name="RightCurly" />

<module name="NeedBraces" />

```

* 类检查

```
        
        <module name="FinalClass" />

<module name="HideUtilityClassConstructor" />

<module name="InnerTypeLast" />

<module name="InterfaceIsType" />

<module name="MutableException"/>

<module name="OneTopLevelClass" />

<module name="ThrowsCount" />

<module name="VisibilityModifier">
            <property name="packageAllowed" value="true" />
            <property name="publicMemberPattern" value="^$" />
            <property name="allowPublicImmutableFields" value="true" />
            <property name="ignoreAnnotationCanonicalNames" value="Inject,Bind" />
        </module>

```

* 代码检查

```
        
        <module name="ArrayTrailingComma" />

<module name="AvoidInlineConditionals"/>

<module name="CovariantEquals" />

<module name="DeclarationOrder" />

<module name="DefaultComesLast" />

<module name="EmptyStatement" />

<module name="EqualsAvoidNull" />

<module name="EqualsHashCode" />

<module name="ExplicitInitialization" />

<module name="FallThrough" />

<module name="FinalLocalVariable" />

<module name="HiddenField">
            <property name="ignoreConstructorParameter" value="true" />
            <property name="ignoreSetter" value="true" />
            <property name="setterCanReturnItsClass" value="true" />
        </module>

<module name="IllegalCatch" />

<module name="IllegalInstantiation">
            <property name="classes" value="java.lang.Boolean" />
        </module>

<module name="IllegalThrows" />

<module name="IllegalToken" />

<module name="IllegalTokenText">
        <property name="tokens" value="NUM_INT,NUM_LONG"/>
        <property name="format" value="^0[^lx]"/>
        <property name="ignoreCase" value="true"/>
        </module>

<module name="IllegalType" />

<module name="InnerAssignment" />

<module name="MagicNumber"/>

<module name="MissingCtor" />

<module name="MissingSwitchDefault" />

<module name="ModifiedControlVariable">
            <property name="skipEnhancedForLoopVariable" value="true" />
        </module>

<module name="MultipleStringLiterals" />

<module name="MultipleVariableDeclarations" />

<module name="NestedForDepth" />

<module name="NestedIfDepth" />

<module name="NestedTryDepth" />

<module name="NoClone" />

<module name="NoFinalizer" />

<module name="OneStatementPerLine" />

<module name="OverloadMethodsDeclarationOrder" />

<module name="PackageDeclaration" />

<module name="ParameterAssignment" />

<module name="RequireThis" />

<module name="ReturnCount"/>

<module name="SimplifyBooleanExpression" />

<module name="SimplifyBooleanReturn" />

<module name="StringLiteralEquality" />

<module name="SuperClone" />

<module name="SuperFinalize" />

<module name="UnnecessaryParentheses" />

<module name="VariableDeclarationUsageDistance"/>

<module name="LineLength">
            <property name="max" value="200" />
        </module>

<module name="MethodLength">
            <property name="tokens" value="METHOD_DEF" />
        </module>
        
        <module name="MethodLength">
            <property name="tokens" value="CTOR_DEF" />
            <property name="max" value="60" />
        </module>

<module name="ModifierOrder" />

<module name="RedundantModifier" />

<module name="ParameterNumber">
            <property name="max" value="19" />
        </module>

```

* 文件头检查

```
        
        <module name="Header">
        <property name="headerFile" value="config/java.header"/>
        <property name="ignoreLines" value="2, 3, 4"/>
        <property name="fileExtensions" value="java"/>
        </module>

<module name="RegexpHeader">
        <property name="headerFile" value="config/java.header"/>
        <property name="multiLines" value="10, 13"/>
        </module>

```

* 导包检查

```
        
        <module name="AvoidStarImport" />

<module name="AvoidStaticImport" />

<module name="ImportOrder">
        <property name="groups" value="/^java\./,javax,org,com"/>
        <property name="ordered" value="true"/>
        <property name="separated" value="true"/>
        <property name="option" value="above"/>
        <property name="sortStaticImportsAlphabetically" value="true"/>
        </module>

<module name="CustomImportOrder">
        <property name="customImportOrderRules"
        value="STATIC###STANDARD_JAVA_PACKAGE###SPECIAL_IMPORTS###THIRD_PARTY_PACKAGE"/>
        <property name="specialImportsRegExp" value="^org\."/>
        <property name="thirdPartyPackageRegExp" value="^com\."/>
        <property name="sortImportsInGroupAlphabetically" value="true"/>
        <property name="separateLineBetweenGroups" value="true"/>
        </module>

<module name="IllegalImport" />

<module name="ImportControl">
        <property name="file" value="config/import-control.xml"/>
        </module>

<module name="RedundantImport" />

<module name="UnusedImports" />

<module name="AtclauseOrder">
            <property name="tagOrder" value="@author, @version, @param,
                           @return, @throws, @exception, @see, @since, @serial,
                           @serialField, @serialData, @deprecated" />
            <property name="target" value="CLASS_DEF, INTERFACE_DEF, ENUM_DEF,
                           METHOD_DEF, CTOR_DEF, VARIABLE_DEF" />
        </module>

<module name="JavadocMethod">
            <property name="scope" value="private" />
            <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" />
            
            <property name="allowMissingPropertyJavadoc" value="true" />
        </module>

<module name="JavadocParagraph" />

<module name="JavadocStyle" />

<module name="JavadocTagContinuationIndentation" />

<module name="JavadocType">
            <property name="authorFormat" value="\S" />
            <property name="scope" value="protected" />
            <property name="tokens" value="CLASS_DEF,INTERFACE_DEF" />
        </module>

<module name="JavadocVariable">
            <property name="scope" value="private" />
        </module>

<module name="NonEmptyAtclauseDescription" />

<module name="SingleLineJavadoc" />

<module name="SummaryJavadocCheck" />

<module name="WriteTag">
        <property name="tag" value="@incomplete"/>
        <property name="tagFormat" value="\S"/>
        <property name="severity" value="ignore"/>
        <property name="tagSeverity" value="warning"/>
        </module>

```

* 度量检查

```
        
        <module name="BooleanExpressionComplexity">
            <property name="max" value="7" />
        </module>

<module name="ClassDataAbstractionCoupling" />

<module name="ClassFanOutComplexity" />

<module name="CyclomaticComplexity" />

<module name="JavaNCSS">
                    <property name="methodMaximum" value="50" />
                </module>

<module name="NPathComplexity" />

```

* 命名规范检查

```
        
        <module name="AbbreviationAsWordInName" />

<module name="AbstractClassName"/>

<module name="CatchParameterName"/>

<module name="ClassTypeParameterName"/>

<module name="LocalFinalVariableName" />

<module name="LocalVariableName" />

<module name="StaticVariableName">
            <property name="format" value="(^[A-Z0-9_]{0,29}$)" />
        </module>

<module name="PackageName">
            <property name="format" value="^[a-z]+(\.[a-z][a-z0-9]*)*$" />
        </module>

<module name="TypeName">
            <property name="format" value="(^[A-Z][a-zA-Z0-9]{0,29}$)" />
        </module>

<module name="MethodName">
            <property name="format" value="(^[a-z][a-zA-Z0-9]{0,29}$)" />
        </module>

<module name="MemberName">
            <property name="format" value="(^[a-z][a-zA-Z0-9]{0,29}$)" />
        </module>

<module name="ParameterName">
            <property name="format" value="(^[a-z][a-zA-Z0-9_]{0,29}$)" />
        </module>

<module name="ConstantName">
            <property name="format" value="(^[A-Z0-9_]{0,29}$)" />
        </module>

<module name="Indentation" />

```

* 其他检查...
```

```
------

# 三. Checkstyle的具体使用

* 安装CheckStyle-IDEA 插件

![这里写图片描述](http://img.blog.csdn.net/20170606110829508?watermark/2/text/aHR0cDovL2Jsb2cuY3Nkbi5uZXQvbmFpdm9y/font/5a6L5L2T/fontsize/400/fill/I0JBQkFCMA==/dissolve/70/gravity/SouthEast)

* 添加CheckStyle 配置文件

![这里写图片描述](http://img.blog.csdn.net/20170606111013593?watermark/2/text/aHR0cDovL2Jsb2cuY3Nkbi5uZXQvbmFpdm9y/font/5a6L5L2T/fontsize/400/fill/I0JBQkFCMA==/dissolve/70/gravity/SouthEast)
* 代码检查中勾选CheckStyle

![这里写图片描述](http://img.blog.csdn.net/20170606111102011?watermark/2/text/aHR0cDovL2Jsb2cuY3Nkbi5uZXQvbmFpdm9y/font/5a6L5L2T/fontsize/400/fill/I0JBQkFCMA==/dissolve/70/gravity/SouthEast)
* 进行代码检查

* 通过checkstyle功能区

![这里写图片描述](http://img.blog.csdn.net/20170606111147090?watermark/2/text/aHR0cDovL2Jsb2cuY3Nkbi5uZXQvbmFpdm9y/font/5a6L5L2T/fontsize/400/fill/I0JBQkFCMA==/dissolve/70/gravity/SouthEast)

* 通过右键检查当前文件

![这里写图片描述](http://img.blog.csdn.net/20170606111221029?watermark/2/text/aHR0cDovL2Jsb2cuY3Nkbi5uZXQvbmFpdm9y/font/5a6L5L2T/fontsize/400/fill/I0JBQkFCMA==/dissolve/70/gravity/SouthEast)

* 通过gradle任务

![这里写图片描述](http://img.blog.csdn.net/20170606111242970?watermark/2/text/aHR0cDovL2Jsb2cuY3Nkbi5uZXQvbmFpdm9y/font/5a6L5L2T/fontsize/400/fill/I0JBQkFCMA==/dissolve/70/gravity/SouthEast)

------

以上总结可能还有很多不到位的地方，欢迎大家指正和交流。

去Checkstyle网站查看 [更多类容 ](http://checkstyle.sourceforge.net/index.html)

CheckStyle

CheckStyle 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

CheckStyle

CheckStyle 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

Download README