Checkstyle是一个检查java文件编码规范的开源工具,最新版本支持184个检查规则。

Checkstyle官网如下:

https://checkstyle.sourceforge.io

Checkstyle的GitHub地址如下:

https://github.com/checkstyle/checkstyle

如下是目前支持的所有检查规则:

1.AbbreviationAsWordInName【Since Checkstyle 5.8】

Validates abbreviations (consecutive capital letters) length in identifier name, it also allows to enforce camel case naming.

标识符名称中的缩写

验证标识符名称中的缩写(连续大写字母)长度,它还允许强制使用骆驼大小写命名。

2.AbstractClassName【Since Checkstyle 3.2】

Ensures that the names of abstract classes conforming to some pattern and check that abstract modifier exists.

抽象类名称

确保抽象类的名称符合某种模式,并检查抽象修饰符是否存在。

3.AnnotationLocation【Since Checkstyle 6.0】

Checks location of annotation on language elements.

注解位置

检查注解在语言元素上的位置。

4.AnnotationOnSameLine【Since Checkstyle 8.2】

Checks that annotations are located on the same line with their targets.

注解位于同一行

检查注解是否与其目标位于同一行。

5.AnnotationUseStyle【Since Checkstyle 5.0】

Checks the style of elements in annotations.

注解使用样式

检查注解中元素的样式。

6.AnonInnerLength【Since Checkstyle 3.2】

Checks for long anonymous inner classes.

匿名内部类长度

检查匿名内部类的长度。

7.ArrayTrailingComma【Since Checkstyle 3.2】

Checks that array initialization contains a trailing comma.

数组尾部逗号

检查数组初始化是否包含尾部逗号。

8.ArrayTypeStyle【Since Checkstyle 3.1】

Checks the style of array type definitions.

数组类型样式

检查数组类型定义的样式。

9.AtclauseOrder【Since Checkstyle 6.0】

Checks the order of javadoc block-tags or javadoc tags.

javadoc标记(以@开头的元素)的顺序

检查javadoc块标记或javadoc标记的顺序。

10.AvoidDoubleBraceInitialization【Since Checkstyle 8.30】

Detects double brace initialization.

避免双大括号初始化

检测双大括号初始化。

11.AvoidEscapedUnicodeCharacters【Since Checkstyle 5.8】

Restricts using Unicode escapes (such as \u221e).

避免转义Unicode字符

限制使用Unicode转义符(如\u221e)。

12.AvoidInlineConditionals【Since Checkstyle 3.1】

Detects inline conditionals.

避免内联条件

检测内联条件。

13.AvoidNestedBlocks【Since Checkstyle 3.1】

Finds nested blocks (blocks that are used freely in the code).

避免嵌套块

查找嵌套块(代码中可以自由使用的块)。

14.AvoidNoArgumentSuperConstructorCall【Since Checkstyle 8.29】

Checks if call to superclass constructor without arguments is present.

避免无参数父构造方法调用

检查是否存在对无参数的父构造方法的调用。

15.AvoidStarImport【Since Checkstyle 3.0】

Checks that there are no import statements that use the * notation.

避免星号(*)导入

检查是否没有使用*符号的导入语句。

16.AvoidStaticImport【Since Checkstyle 5.0】

Checks that there are no static import statements.

避免静态导入

检查是否没有静态导入语句。

17.BooleanExpressionComplexity【Since Checkstyle 3.4】

Restricts the number of boolean operators (&&, ||, &, | and ^) in an expression.

布尔表达式复杂度

限制表达式中布尔运算符(&&、||、&、|、^)的数量。

18.CatchParameterName【Since Checkstyle 6.14】

Checks that catch parameter names conform to a specified pattern.

捕获参数名称

检查捕获参数名称是否符合指定模式。

19.ClassDataAbstractionCoupling【Since Checkstyle 3.4】

Measures the number of instantiations of other classes within the given class or record.

类数据抽象耦合

测量给定类或记录中其他类的实例化数量。

20.ClassFanOutComplexity【Since Checkstyle 3.4】

Checks the number of other types a given class/record/interface/enum/annotation relies on.

类依赖复杂度

检查给定类/记录/接口/枚举/注解所依赖的其他类型的数量。

21.ClassMemberImpliedModifier【Since Checkstyle 8.16】

Checks for implicit modifiers on nested types in classes and records.

类成员隐含修饰符

检查类和记录中嵌套类型的隐式修饰符。

22.ClassTypeParameterName【Since Checkstyle 5.0】

Checks that class type parameter names conform to a specified pattern.

类类型参数名称

检查类类型参数名称是否符合指定的模式。

23.CommentsIndentation【Since Checkstyle 6.10】

Controls the indentation between comments and surrounding code.

注释缩进

控制注释和周围代码之间的缩进。

24.ConstantName【Since Checkstyle 3.0】

Checks that constant names conform to a specified pattern.

常量名称

检查常量名称是否符合指定的模式。

25.CovariantEquals【Since Checkstyle 3.2】

Checks that classes and records which define a covariant equals() method also override method equals(Object).

重写equals方法

检查重写equals()方法的类和记录是否也重写了equals(Object)方法。

26.CustomImportOrder【Since Checkstyle 5.8】

Checks that the groups of import declarations appear in the order specified by the user.

自定义导入顺序

检查导入声明组是否按用户指定的顺序排列。

27.CyclomaticComplexity【Since Checkstyle 3.2】

Checks cyclomatic complexity against a specified limit.

循环复杂度

根据指定的限制检查圈复杂度。

28.DeclarationOrder【Since Checkstyle 3.2】

Checks that the parts of a class, record, or interface declaration appear in the order suggested by the Code Conventions for the Java Programming Language.

声明顺序

检查类、记录或接口声明的部分是否按Java编程语言代码惯例建议的顺序排列。

29.DefaultComesLast【Since Checkstyle 3.4】

Check that the default is after all the cases in a switch statement.

default最后出现

检查default是否在switch语句中的所有case之后。

30.DescendantToken【Since Checkstyle 3.2】

Checks for restricted tokens beneath other tokens.

后代令牌

检查其他令牌下的受限令牌。

31.DesignForExtension【Since Checkstyle 3.1】

Checks that classes are designed for extension (subclass creation).

扩展设计

检查类是否为扩展(子类创建)而设计。

32.EmptyBlock【Since Checkstyle 3.0】

Checks for empty blocks.

空区块

检查空区块。

33.EmptyCatchBlock【Since Checkstyle 6.4】

Checks for empty catch blocks.

空捕获块

检查是否有空的捕获块。

34.EmptyForInitializerPad【Since Checkstyle 3.4】

Checks the padding of an empty for initializer; that is whether a white space is required at an empty for initializer, or such white space is forbidden.

for初始化的空填充

检查初始值设定项的空填充;也就是说,在空的for初始值设定项中是否需要空格,或者是否禁止这样的空格。

35.EmptyForIteratorPad【Since Checkstyle 3.0】

Checks the padding of an empty for iterator; that is whether a white space is required at an empty for iterator, or such white space is forbidden.

迭代器的空填充

检查迭代器的空填充;也就是说,在空的for迭代器中是否需要空格,或者禁止这样的空格。

36.EmptyLineSeparator【Since Checkstyle 5.8】

Checks for empty line separators before package, all import declarations, fields, constructors, methods, nested classes, static initializers and instance initializers.

空行分隔符

检查包声明、所有导入声明、字段、构造方法、方法、嵌套类、静态初始化器和实例初始化器之前的空行分隔符。

37.EmptyStatement【Since Checkstyle 3.1】

Detects empty statements (standalone ";" semicolon).

空语句

检测空语句(独立的";"分号)。

38.EqualsAvoidNull【Since Checkstyle 5.0】

Checks that any combination of String literals is on the left side of an equals() comparison.

equals比较时避免null

检查字符串文本的任何组合是否位于equals()比较的左侧。

39.EqualsHashCode【Since Checkstyle 3.0】

Checks that classes that either override equals() or hashCode() also overrides the other.

equals和hashCode方法

检查重写equals()的类是否也重写了hashCode()方法。

40.ExecutableStatementCount【Since Checkstyle 3.2】

Restricts the number of executable statements to a specified limit.

可执行语句计数

将可执行语句的数量限制为指定值。

41.ExplicitInitialization【Since Checkstyle 3.2】

Checks if any class or object member is explicitly initialized to default for its type value (null for object references, zero for numeric types and char and false for boolean.)

显式初始化

检查是否将任何类或对象成员显式初始化为其类型值的默认值(对象引用为null,数字类型为0,布尔值为false)。

42.FallThrough【Since Checkstyle 3.4】

Checks for fall-through in switch statements.

漏写

检查switch语句中的漏写。

43.FileLength【Since Checkstyle 5.0】

Checks for long source files.

文件长度

检查长的源文件。

44.FileTabCharacter【Since Checkstyle 5.0】

Checks that there are no tab characters ('\t') in the source code.

文件制表符

检查源代码中是否没有制表符('\t')。

45.FinalClass【Since Checkstyle 3.1】

Checks that a class that has only private constructors and has no descendant classes is declared as final.

final类

检查只有私有构造方法且没有子类的类是否声明为final。

46.FinalLocalVariable【Since Checkstyle 3.2】

Checks that local variables that never have their values changed are declared final.

final局部变量

检查从未更改其值的局部变量是否声明为final。

47.FinalParameters【Since Checkstyle 3.0】

Checks that parameters for methods, constructors, catch and for-each blocks are final.

final参数

检查方法、构造方法、catch和for-each块的参数是否为final。

48.GenericWhitespace【Since Checkstyle 5.0】

Checks that the whitespace around the Generic tokens (angle brackets) "<" and ">" are correct to the typical convention.

通用空白

检查泛型标记(尖括号)“<”和“>”周围的空格是否符合典型惯例。

49.Header【Since Checkstyle 6.9】

Checks that a source file begins with a specified header.

标头

检查源文件是否以指定的标头开头。

50.HiddenField【Since Checkstyle 3.0】

Checks that a local variable or a parameter does not shadow a field that is defined in the same class.

隐藏字段

检查局部变量或参数是否覆盖在同一类中定义的字段。

51.HideUtilityClassConstructor【Since Checkstyle 3.1】

Makes sure that utility classes (classes that contain only static methods or fields in their API) do not have a public constructor.

隐藏工具类构造方法

确保工具类(在其API中仅包含静态方法或字段的类)没有公共构造方法。

52.IllegalCatch【Since Checkstyle 3.2】

Checks that certain exception types do not appear in a catch statement.

非法捕获

检查某些异常类型是否未出现在catch语句中。

53.IllegalIdentifierName【Since Checkstyle 8.36】

Checks identifiers with a pattern for a set of illegal names, such as those that are restricted or contextual keywords.

非法标识符名称

使用一组非法名称的模式检查标识符,例如受限制的名称或上下文关键字。

54.IllegalImport【Since Checkstyle 3.0】

Checks for imports from a set of illegal packages.

非法导入

从一组非法包中检查导入。

55.IllegalInstantiation【Since Checkstyle 3.0】

Checks for illegal instantiations where a factory method is preferred.

非法实例化

检查首选工厂方法的非法实例化。

56.IllegalThrows【Since Checkstyle 4.0】

Checks that specified types are not declared to be thrown.

非法抛出异常

检查指定的类型是否未声明为可抛出异常。

57.IllegalToken【Since Checkstyle 3.2】

Checks for illegal tokens.

非法令牌

检查非法令牌。

58.IllegalTokenText【Since Checkstyle 3.2】

Checks specified tokens text for matching an illegal pattern.

非法令牌文本

检查指定的标记文本是否与非法模式匹配。

59.IllegalType【Since Checkstyle 3.2】

Checks that particular classes or interfaces are never used.

非法类型

检查是否从未使用特定的类或接口。

60.ImportControl【Since Checkstyle 4.0】

Controls what can be imported in each package and file.

导入控制

控制每个包和文件中可以导入的内容。

61.ImportOrder【Since Checkstyle 3.2】

Checks the ordering/grouping of imports.

导入顺序

检查导入的顺序/分组。

62.Indentation【Since Checkstyle 3.1】

Checks correct indentation of Java code.

缩进

检查Java代码的正确缩进。

63.InnerAssignment【Since Checkstyle 3.0】

Checks for assignments in subexpressions, such as in String s = Integer.toString(i = 2);.

内部赋值

检查子表达式中的赋值,例如String s = Integer.toString(i = 2);中的赋值。

64.InnerTypeLast【Since Checkstyle 5.2】

Checks nested (internal) classes/interfaces are declared at the bottom of the primary (top-level) class after all init and static init blocks, method, constructor and field declarations.

内部类型声明在后面

检查嵌套(内部)类/接口是否在所有init和静态init块、方法、构造方法和字段声明之后在主(顶级)类的底部声明。

65.InterfaceIsType【Since Checkstyle 3.1】

Implements Joshua Bloch, Effective Java, Item 17 - Use Interfaces only to define types.

接口定义类型

实现Joshua Bloch,有效Java,第17项-仅使用接口定义类型。

66.InterfaceMemberImpliedModifier【Since Checkstyle 8.12】

Checks for implicit modifiers on interface members and nested types.

接口成员隐含修饰符

检查接口成员和嵌套类型上的隐含修饰符。

67.InterfaceTypeParameterName【Since Checkstyle 5.8】

Checks that interface type parameter names conform to a specified pattern.

接口类型参数名称

检查接口类型参数名称是否符合指定模式。

68.InvalidJavadocPosition【Since Checkstyle 8.23】

Checks that Javadocs are located at the correct position.

无效的javadoc位置

检查javadoc是否位于正确位置。

69.JavadocBlockTagLocation【Since Checkstyle 8.24】

Checks that a javadoc block tag appears only at the beginning of a line, ignoring leading asterisks and white space.

Javadoc块标记位置

检查javadoc块标记是否仅出现在行的开头,忽略前导星号和空格。

70.JavadocContentLocation【Since Checkstyle 8.27】

Checks that the Javadoc content begins from the same position for all Javadoc comments in the project.

Javadoc内容位置

检查Javadoc内容是否从项目中所有Javadoc注释的相同位置开始。

71.JavadocMethod【Since Checkstyle 3.0】

Checks the Javadoc of a method or constructor.

Javadoc方法

检查方法或构造方法的Javadoc。

72.JavadocMissingLeadingAsterisk【Since Checkstyle 8.38】

Checks if the javadoc has leading asterisks on each line.

Javadoc缺失前导星号

检查javadoc是否每行都有前导星号。

73.JavadocMissingWhitespaceAfterAsterisk【Since Checkstyle 8.32】

Checks that there is at least one whitespace after the leading asterisk.

Javadoc星号后缺少空格

检查前导星号后是否至少有一个空格。

74.JavadocPackage【Since Checkstyle 5.0】

Checks that each Java package has a Javadoc file used for commenting.

Javadoc包

检查每个Java包是否有一个用于注释的Javadoc文件。

75.JavadocParagraph【Since Checkstyle 6.0】

Checks the Javadoc paragraph.

Javadoc段落

检查Javadoc段落。

76.JavadocStyle【Since Checkstyle 3.2】

Validates Javadoc comments to help ensure they are well formed.

Javadoc样式

验证Javadoc注释,以帮助确保它们格式正确。

77.JavadocTagContinuationIndentation【Since Checkstyle 6.0】

Checks the indentation of the continuation lines in block tags.

Javadoc标记连续缩进

检查块标记中连续行的缩进。

78.JavadocType【Since Checkstyle 3.0】

Checks the Javadoc comments for type definitions.

Javadoc类型

检查Javadoc注释中的类型定义。

79.JavadocVariable【Since Checkstyle 3.0】

Checks that a variable has a Javadoc comment.

Javadoc变量

检查变量是否具有Javadoc注释。

80.JavaNCSS【Since Checkstyle 3.5】

Determines complexity of methods, classes and files by counting the Non Commenting Source Statements (NCSS).

Java NCSS

通过计算非注释源语句(NCSS)来确定方法、类和文件的复杂度。

81.LambdaBodyLength【Since Checkstyle 8.37】

Checks lambda body length.

Lambda body长度

检查lambda body长度。

82.LambdaParameterName【Since Checkstyle 8.11】

Checks lambda parameter names.

Lambda参数名称

检查lambda参数名称。

83.LeftCurly【Since Checkstyle 3.0】

Checks for the placement of left curly braces ('{') for code blocks.

左大括号

检查代码块的左大括号("{")的位置。

84.LineLength【Since Checkstyle 3.0】

Checks for long lines.

行字符数

检查每行字符数。

85.LocalFinalVariableName【Since Checkstyle 3.0】

Checks that local final variable names conform to a specified pattern.

局部final变量名称

检查局部final变量名是否符合指定模式。

86.LocalVariableName【Since Checkstyle 3.0】

Checks that local, non-final variable names conform to a specified pattern.

局部变量名称

检查局部非final变量名是否符合指定模式。

87.MagicNumber【Since Checkstyle 3.1】

Checks that there are no "magic numbers" where a magic number is a numeric literal that is not defined as a constant.

魔法数字

检查是否没有“魔法数字”,其中魔法数字是未定义为常量的数字。

88.MatchXpath【Since Checkstyle 8.39】

Evaluates Xpath query and report violation on all matching AST nodes.

匹配Xpath

评估所有匹配AST节点上的Xpath查询和报告冲突。

89.MemberName【Since Checkstyle 3.0】

Checks that instance variable names conform to a specified pattern.

成员名称

检查实例变量名称是否符合指定的模式。

90.MethodCount【Since Checkstyle 5.3】

Checks the number of methods declared in each type declaration by access modifier or total count.

方法计数

检查每个类型声明中声明的方法数。

91.MethodLength【Since Checkstyle 3.0】

Checks for long methods and constructors.

方法长度

检查长方法和构造方法。

92.MethodName【Since Checkstyle 3.0】

Checks that method names conform to a specified pattern.

方法名称

检查方法名称是否符合指定的模式。

93.MethodParamPad【Since Checkstyle 3.4】

Checks the padding between the identifier of a method definition, constructor definition, method call, or constructor invocation; and the left parenthesis of the parameter list.

方法参数填充

检查方法定义、构造方法定义、方法调用或构造方法调用的标识符之间的填充;以及参数列表的左括号。

94.MethodTypeParameterName【Since Checkstyle 5.0】

Checks that method type parameter names conform to a specified pattern.

方法类型参数名称

检查方法类型参数名称是否符合指定模式。

95.MissingCtor【Since Checkstyle 3.4】

Checks that classes (except abstract ones) define a constructor and don't rely on the default one.

缺失构造方法

检查类(抽象类除外)是否定义构造方法,并且不依赖默认构造方法。

96.MissingDeprecated【Since Checkstyle 5.0】

Verifies that the annotation @Deprecated and the Javadoc tag @deprecated are both present when either of them is present.

缺失@Deprecated注解

验证注解@Deprecated和Javadoc标记@deprecated是否都存在。

97.MissingJavadocMethod【Since Checkstyle 8.21】

Checks for missing Javadoc comments for a method or constructor.

缺失Javadoc的方法

检查方法或构造方法是否缺少Javadoc注释。

98.MissingJavadocPackage【Since Checkstyle 8.22】

Checks for missing package definition Javadoc comments in package-info.java files.

缺失包的Javadoc

检查package-info.java文件中是否缺少包定义的Javadoc注释。

99.MissingJavadocType【Since Checkstyle 8.20】

Checks for missing Javadoc comments for class, enum, interface, and annotation interface definitions.

缺失Javadoc的类型

检查类、枚举、接口和注解接口定义是否缺少Javadoc注释。

100.MissingOverride【Since Checkstyle 5.0】

Verifies that the @Override annotation is present when the @inheritDoc javadoc tag is present.

缺失@Override

验证@inheritDoc javadoc标记存在时是否存在@Override注解。

101.MissingSwitchDefault【Since Checkstyle 3.1】

Checks that switch statement has a default clause.

switch中缺失default

检查switch语句是否具有default子句。

102.ModifiedControlVariable【Since Checkstyle 3.5】

Checks that for loop control variables are not modified inside the for block.

修改的控制变量

检查for循环控制变量是否未在for块内修改。

103.ModifierOrder【Since Checkstyle 3.0】

Checks that the order of modifiers conforms to the suggestions in the Java Language specification, § 8.1.1, 8.3.1, 8.4.3 and 9.4.

修饰符顺序

检查修饰符的顺序是否符合Java语言规范§8.1.1、8.3.1、8.4.3和9.4中的建议。

104.MultipleStringLiterals【Since Checkstyle 3.5】

Checks for multiple occurrences of the same string literal within a single file.

多个字符串字面值

检查同一字符串字面值在单个文件中是否多次出现。

105.MultipleVariableDeclarations【Since Checkstyle 3.4】

Checks that each variable declaration is in its own statement and on its own line.

多个变量声明

检查每个变量声明是否在其自己的语句中并位于其自己的行上。

106.MutableException【Since Checkstyle 3.2】

Ensures that exception classes (classes with names conforming to some pattern and explicitly extending classes with names conforming to other pattern) are immutable, that is, that they have only final fields.

可变异常

确保异常类(名称符合某种模式的类和名称符合其他模式的显式扩展类)是不可变的,即它们只有final字段。

107.NeedBraces【Since Checkstyle 3.0】

Checks for braces around code blocks.

需要大括号

检查代码块周围的大括号。

108.NestedForDepth【Since Checkstyle 5.3】

Restricts nested for blocks to a specified depth.

嵌套的深度

将块的嵌套限制为指定深度。

109.NestedIfDepth【Since Checkstyle 3.2】

Restricts nested if-else blocks to a specified depth.

嵌套if深度

将嵌套的if-else块限制为指定的深度。

110.NestedTryDepth【Since Checkstyle 3.2】

Restricts nested try-catch-finally blocks to a specified depth.

嵌套try深度

将嵌套的try-catch-finally块限制到指定的深度。

111.NewlineAtEndOfFile【Since Checkstyle 3.1】

Checks whether files end with a line separator.

文件末尾的换行符

检查文件是否以行分隔符结尾。

112.NoArrayTrailingComma【Since Checkstyle 8.28】

Checks that array initialization do not contain a trailing comma.

无数组尾随逗号

检查数组初始化是否不包含尾随逗号。

113.NoClone【Since Checkstyle 5.0】

Checks that the clone method is not overridden from the Object class.

不克隆

检查克隆方法是否未从Object类重写。

114.NoCodeInFile【Since Checkstyle 8.33】

Checks whether file contains code.

文件中无代码

检查文件是否包含代码。

115.NoFinalizer【Since Checkstyle 5.0】

Checks that there is no method finalize with zero parameters.

无finalize()

检查文件中是否没有方法finalize()。

116.NoLineWrap【Since Checkstyle 5.8】

Checks that chosen statements are not line-wrapped.

无换行符

检查所选语句是否不换行。

117.NonEmptyAtclauseDescription【Since Checkstyle 6.0】

Checks that the block tag is followed by description.

非空标记说明

检查块标记后面是否有描述。

118.NoEnumTrailingComma【Since Checkstyle 8.29】

Checks that enum definition does not contain a trailing comma.

无枚举尾随逗号

检查枚举定义是否不包含尾随逗号。

119.NoWhitespaceAfter【Since Checkstyle 3.0】

Checks that there is no whitespace after a token.

后面没有空格

检查标记后面是否没有空格。

120.NoWhitespaceBefore【Since Checkstyle 3.0】

Checks that there is no whitespace before a token.

前面没有空格

检查标记前面是否没有空格。

121.NoWhitespaceBeforeCaseDefaultColon【Since Checkstyle 8.45】

Checks that there is no whitespace before the colon in a switch block.

在case和default冒号前没有空格

检查switch块中冒号前是否没有空格。

122.NPathComplexity【Since Checkstyle 3.4】

Checks the NPATH complexity against a specified limit.

NPATH复杂度

根据指定的限制检查NPATH复杂度。

123.OneStatementPerLine【Since Checkstyle 5.3】

Checks that there is only one statement per line.

每行一个语句

检查每行只有一条语句。

124.OneTopLevelClass【Since Checkstyle 5.8】

Checks that each top-level class, interface, enum or annotation resides in a source file of its own.

一个顶级类

检查每个顶级类、接口、枚举或注解是否驻留在自己的源文件中。

125.OperatorWrap【Since Checkstyle 3.0】

Checks the policy on how to wrap lines on operators.

运算符换行

检查有关如何换行运算符的策略。

126.OrderedProperties【Since Checkstyle 8.22】

Detects if keys in properties files are in correct order.

有序属性

检测属性文件中的键的顺序是否正确。

127.OuterTypeFilename【Since Checkstyle 5.3】

Checks that the outer type name and the file name match.

外部类型文件名

检查外部类型名称和文件名是否匹配。

128.OuterTypeNumber【Since Checkstyle 5.0】

Checks for the number of types declared at the outer (or root) level in a file.

外部类型数量

检查文件中在外部(或根)级别声明的类型的数量。

129.OverloadMethodsDeclarationOrder【Since Checkstyle 5.8】

Checks that overloaded methods are grouped together.

重载方法声明顺序

检查重载方法是否分组在一起。

130.PackageAnnotation【Since Checkstyle 5.0】

Checks that all package annotations are in the package-info.java file.

包注解

检查所有包注解是否位于package-info.java文件中。

131.PackageDeclaration【Since Checkstyle 3.2】

Ensures that a class has a package declaration, and (optionally) whether the package name matches the directory name for the source file.

包声明

确保类具有包声明,以及(可选)包名称是否与源文件的目录名称匹配。

132.PackageName【Since Checkstyle 3.0】

Checks that package names conform to a specified pattern.

包名称

检查包名称是否符合指定的模式。

133.ParameterAssignment【Since Checkstyle 3.2】

Disallows assignment of parameters.

参数赋值

不允许给参数赋值。

134.ParameterName【Since Checkstyle 3.0】

Checks that method parameter names conform to a specified pattern.

参数名称

检查方法参数名称是否符合指定模式。

135.ParameterNumber【Since Checkstyle 3.0】

Checks the number of parameters of a method or constructor.

参数数量

检查方法或构造方法的参数数量。

136.ParenPad【Since Checkstyle 3.0】

Checks the policy on the padding of parentheses; that is whether a space is required after a left parenthesis and before a right parenthesis, or such spaces are forbidden.

小括号填充

检查括号填充的策略;也就是说,左小括号之后和右小括号之前是否需要空格,或者禁止使用此类空格。

137.PatternVariableName【Since Checkstyle 8.36】

Checks that pattern variable names conform to a specified pattern.

模式变量名称

检查模式变量名称是否符合指定的模式。

138.RecordComponentNumber【Since Checkstyle 8.36】

Checks the number of record components in the header of a record definition.

记录组件数量

检查记录定义标题中记录组件的数量。

139.RecordComponentName【Since Checkstyle 8.40】

Checks that record component names conform to a specified pattern.

记录组件名称

检查记录组件名称是否符合指定的模式。

140.RecordTypeParameterName【Since Checkstyle 8.36】

Checks that record type parameter names conform to a specified pattern.

记录类型参数名称

检查记录类型参数名称是否符合指定模式。

141.RedundantImport【Since Checkstyle 3.0】

Checks for redundant import statements.

冗余导入

检查冗余的导入语句。

142.RedundantModifier【Since Checkstyle 3.0】

Checks for redundant modifiers.

冗余修饰符

检查冗余的修饰符。

143.Regexp【Since Checkstyle 4.0】

Checks that a specified pattern exists, exists less than a set number of times, or does not exist in the file.

正则表达式

检查指定的模式是否存在、存在的次数是否少于设置的次数或文件中是否不存在。

144.RegexpHeader【Since Checkstyle 6.9】

Checks the header of a source file against a header that contains a pattern for each line of the source header.

正则表达式标头

根据正则表达式检查源文件的标头。

145.RegexpMultiline【Since Checkstyle 5.0】

Checks that a specified pattern matches across multiple lines in any file type.

正则表达式多行

根据正则表达式检查任何文件类型的多行文本。

146.RegexpOnFilename【Since Checkstyle 6.15】

Checks that a specified pattern matches based on file and/or folder path.

正则表达式文件名

根据正则表达式检查文件或目录名称。

147.RegexpSingleline【Since Checkstyle 5.0】

Checks that a specified pattern matches a single-line in any file type.

正则表达式单行

根据正则表达式检查任何文件类型中的单行。

148.RegexpSinglelineJava【Since Checkstyle 6.0】

Checks that a specified pattern matches a single-line in Java files.

正则表达式单行Java

根据正则表达式检查java文件中的单行。

149.RequireThis【Since Checkstyle 3.4】

Checks that references to instance variables and methods of the present object are explicitly of the form "this.varName" or "this.methodName(args)" and that those references don't rely on the default behavior when "this." is absent.

需要this关键字

检查对当前对象的实例变量和方法的引用是否显式采用“this.varName”或“this.methodName(args)”的形式,并且当缺少“this.”时,这些引用不依赖默认行为。

150.ReturnCount【Since Checkstyle 3.2】

Restricts the number of return statements in methods, constructors and lambda expressions.

返回计数

限制方法、构造方法和lambda表达式中返回语句的数量。

151.RightCurly【Since Checkstyle 3.0】

Checks the placement of right curly braces ('}') for code blocks.

右大括号

检查代码块的右大括号("}")的位置。

152.SeparatorWrap【Since Checkstyle 5.8】

Checks line wrapping with separators.

分隔符换行

检查带分隔符的换行。

153.SimplifyBooleanExpression【Since Checkstyle 3.0】

Checks for over-complicated boolean expressions.

简化布尔表达式

检查过于复杂的布尔表达式。

154.SimplifyBooleanReturn【Since Checkstyle 3.0】

Checks for over-complicated boolean return statements.

简化布尔返回

检查过于复杂的布尔返回语句。

155.SingleLineJavadoc【Since Checkstyle 6.0】

Checks that a Javadoc block can fit in a single-line and doesn't contain block tags.

单行Javadoc

检查Javadoc块是否可以放在一行中,并且不包含块标记。

156.RequireEmptyLineBeforeBlockTagGroup【Since Checkstyle 8.36】

Checks that one blank line before the block tag if it is present in Javadoc.

块标记组之前需要空行

检查Javadoc中的块标记前是否有一个空行。

157.SingleSpaceSeparator【Since Checkstyle 6.19】

Checks that non-whitespace characters are separated by no more than one whitespace.

单空格分隔符

检查非空白字符之间的空格数是否超过一个。

158.StaticVariableName【Since Checkstyle 3.0】

Checks that static, non-final variable names conform to a specified pattern.

静态变量名称

检查静态非final变量名是否符合指定模式。

159.StringLiteralEquality【Since Checkstyle 3.2】

Checks that string literals are not used with == or !=.

字符串文字相等

检查字符串文字是否未与==或!=一起使用。

160.SummaryJavadoc【Since Checkstyle 6.0】

Checks that Javadoc summary sentence does not contain phrases that are not recommended to use.

摘要Javadoc

检查Javadoc摘要句子是否包含不建议使用的短语。

161.SuperClone【Since Checkstyle 3.2】

Checks that an overriding clone() method invokes super.clone().

super.clone()方法

检查重写clone()方法时是否调用了super.clone()。

162.SuperFinalize【Since Checkstyle 3.2】

Checks that an overriding finalize() method invokes super.finalize().

super.finalize()方法

检查重写finalize()方法时是否调用了super.finalize()。

163.SuppressWarnings【Since Checkstyle 5.0】

Allows to specify what warnings that @SuppressWarnings is not allowed to suppress.

@SuppressWarnings注解

允许指定不允许@SuppressWarnings抑制的警告。

164.ThrowsCount【Since Checkstyle 3.2】

Restricts throws statements to a specified count.

throws计数

限制throws语句的数量。

165.TodoComment【Since Checkstyle 3.0】

Checks for TODO: comments.

TODO注释

检查TODO:注释。

166.TrailingComment【Since Checkstyle 3.4】

The check to ensure that lines with code do not end with comment.

尾部注释

检查以确保代码行不以注释结尾。

167.Translation【Since Checkstyle 3.0】

Ensures the correct translation of code by checking property files for consistency regarding their keys.

翻译

通过检查属性文件的一致性,确保代码的正确翻译。

168.TypecastParenPad【Since Checkstyle 3.2】

Checks the policy on the padding of parentheses for typecasts.

类型转换的小括号填充

检查类型转换的小括号填充策略。

169.TypeName【Since Checkstyle 3.0】

Checks that type names conform to a specified pattern.

类型名

检查类型名称是否符合指定的模式。

170.UncommentedMain【Since Checkstyle 3.2】

Detects uncommented main methods.

未注释的main方法

检测未注释的main方法。

171.UniqueProperties【Since Checkstyle 5.7】

Detects duplicated keys in properties files.

唯一属性

检测属性文件中的重复属性。

172.UnnecessaryParentheses【Since Checkstyle 3.4】

Checks if unnecessary parentheses are used in a statement or expression.

不必要的小括号

检查语句或表达式中是否使用了不必要的小括号。

173.UnnecessarySemicolonInEnumeration【Since Checkstyle 8.22】

Checks if unnecessary semicolon is in enum definitions.

枚举中不必要的分号

检查枚举定义中是否存在不必要的分号。

174.UnnecessarySemicolonInTryWithResources【Since Checkstyle 8.22】

Checks if unnecessary semicolon is used in last resource declaration.

try资源时不必要的分号

检查最后一个资源声明中是否使用了不必要的分号。

175.UnnecessarySemicolonAfterOuterTypeDeclaration【Since Checkstyle 8.31】

Checks if unnecessary semicolon is used after type declaration.

外部类型声明后不必要的分号

检查类型声明后是否使用了不必要的分号。

176.UnnecessarySemicolonAfterTypeMemberDeclaration【Since Checkstyle 8.24】

Checks if unnecessary semicolon is used after type member declaration.

类型成员声明后不必要的分号

检查类型成员声明后是否使用了不必要的分号。

177.UnusedImports【Since Checkstyle 3.0】

Checks for unused import statements.

未使用的导入

检查未使用的导入语句。

178.UpperEll【Since Checkstyle 3.0】

Checks that long constants are defined with an upper ell.

大写L

检查long常量是否使用大写L定义。

179.UnusedLocalVariable【Since Checkstyle 9.3】

Checks that a local variable is declared and/or assigned, but not used.

未使用的局部变量

检查是否声明和/或分配了局部变量,但未使用。

180.VariableDeclarationUsageDistance【Since Checkstyle 5.8】

Checks the distance between declaration of variable and its first usage.

变量声明使用距离

检查变量声明与其首次使用之间的距离。

181.VisibilityModifier【Since Checkstyle 3.0】

Checks visibility of class members.

可见性修饰符

检查类成员的可见性。

182.WhitespaceAfter【Since Checkstyle 3.0】

Checks that a token is followed by whitespace, with the exception that it does not check for whitespace after the semicolon of an empty for iterator.

后面的空格

检查标记后面是否有空格,但不检查空for迭代器的分号后面是否有空白。

183.WhitespaceAround【Since Checkstyle 3.0】

Checks that a token is surrounded by whitespace.

空格包裹

检查指定标记的是否被空格包裹。

184.WriteTag【Since Checkstyle 4.2】

Requires user defined Javadoc tag to be present in Javadoc comment with defined format.

写入标记

要求用户定义的Javadoc标记以定义的格式出现在Javadoc注释中。

————————————————

版权声明:本文为CSDN博主「火龙映天」的原创文章,遵循CC 4.0 BY-SA版权协议,转载请附上原文出处链接及本声明。

原文链接:https://blog.csdn.net/chenzhengfeng/article/details/128563604