Repository navigation
Expand file tree
/
Copy pathcheck_style.xml
More file actions
92 lines (92 loc) · 4.1 KB
/
Copy pathcheck_style.xml
File metadata and controls
92 lines (92 loc) · 4.1 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
<?xml version="1.0"?>
<!DOCTYPE module PUBLIC
"-//Checkstyle//DTD Checkstyle Configuration 1.3//EN"
"https://checkstyle.org/dtds/configuration_1_3.dtd">
<!--keep the file in project root although NetBeans 8.0.2 doesn't find it there and allow to add additional project files (don't skip a proper project structure in favour of IDE deficies)-->
<!-- Migrated from Checkstyle 6.18 to 14.x in 2026-09 with the same rules (see REFRESH_PLAN.md, Stage A6) -->
<module name="Checker">
<!-- Was inside TreeWalker before Checkstyle 8.24 -->
<module name="LineLength">
<property name="fileExtensions" value="java"/>
<property name="max" value="180"/>
</module>
<module name="TreeWalker">
<!-- Public methods longer than 2 lines must have Javadoc (was part of JavadocMethod before Checkstyle 8.20) -->
<module name="MissingJavadocMethod">
<property name="scope" value="public"/>
<property name="severity" value="error"/>
<property name="allowMissingPropertyJavadoc" value="true"/>
<property name="minLineCount" value="2"/>
<property name="tokens" value="METHOD_DEF"/>
</module>
<!-- Checks the Javadoc of a method: @param/@return tags of existing Javadoc. -->
<module name="JavadocMethod">
<property name="accessModifiers" value="public"/>
<property name="severity" value="error"/>
<property name="tokens" value="METHOD_DEF"/>
</module>
<!-- Public types must have Javadoc (was part of JavadocType before Checkstyle 8.20) -->
<module name="MissingJavadocType">
<property name="scope" value="public"/>
<property name="severity" value="error"/>
</module>
<!-- Checks Javadoc comments for class and interface definitions. -->
<module name="JavadocType">
<property name="scope" value="public"/>
<property name="severity" value="error"/>
</module>
<!-- Checks for Naming Conventions. -->
<!-- See https://checkstyle.org/checks/naming/index.html -->
<!-- Sun Naming Conventions -->
<module name="ConstantName"/>
<module name="LocalFinalVariableName"/>
<module name="LocalVariableName"/>
<module name="MemberName"/>
<module name="MethodName"/>
<module name="PackageName"/>
<module name="ParameterName"/>
<module name="StaticVariableName"/>
<module name="TypeName"/>
<module name="TypeName">
<property name="format"
value="^I[a-zA-Z0-9]*$"/>
<property name="tokens"
value="INTERFACE_DEF"/>
</module>
<module name="InterfaceTypeParameterName"/>
<module name="MethodTypeParameterName"/>
<module name="ClassTypeParameterName"/>
<module name="AnonInnerLength">
<property name="max" value="100"/>
</module>
<module name="ArrayTypeStyle"/>
<module name="EmptyStatement"/>
<module name="EqualsHashCode"/>
<module name="HideUtilityClassConstructor"/>
<module name="MethodLength">
<property name="max" value="200"/>
</module>
<module name="NestedIfDepth">
<property name="max" value="3"/>
</module>
<module name="NestedTryDepth"/>
<module name="StringLiteralEquality"/>
<module name="UncommentedMain"/>
<!-- Specify method parameters code conventions -->
<!--<module name="MethodParamPad">
Whitespace is required after method name
<property name="option" value="space" />
Check only methods and constructors declarations
<property name="tokens" value="METHOD_DEF, CTOR_DEF" />
</module> -->
<!-- Checks the policy on the padding of parentheses; i.e. whether a space is required after a left parenthesis and before a
right parenthesis, or such spaces are forbidden. -->
<!--<module name="ParenPad">
Whitespace required before ')' and after ')'
<property name="option" value="space"/>
</module> -->
</module>
<module name="Translation"/>
<module name="UniqueProperties"/>
<module name="JavadocPackage"/>
</module>