Repository navigation
Expand file tree
/
Copy pathcheckstyle.xml
More file actions
75 lines (72 loc) · 3.06 KB
/
Copy pathcheckstyle.xml
File metadata and controls
75 lines (72 loc) · 3.06 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
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE module PUBLIC
"-//Puppy Crawl//DTD Check Configuration 1.3//EN"
"http://www.puppycrawl.com/dtds/configuration_1_3.dtd">
<!-- This is a checkstyle configuration file. For descriptions of what the
following rules do, please see the checkstyle configuration page at http://checkstyle.sourceforge.net/config.html -->
<module name="Checker">
<!-- 重复代码的检查,超过20行就认为重复,UTF-8格式 -->
<module name="TreeWalker">
<!-- javadoc的检查 -->
<!-- 检查所有的interface和class -->
<module name="JavadocType">
<property name="allowUnknownTags" value="true" />
</module>
<!--<module name="JavadocMethod"> -->
<!--<property name="scope" value="private" /> -->
<!--<property name="allowMissingPropertyJavadoc" value="true" /> -->
<!--<property name="allowMissingParamTags" value="true" /> -->
<!--<property name="logLoadErrors" value="true" /> -->
<!--<property name="suppressLoadErrors" value="true" /> -->
<!--</module> -->
<!-- 命名方面的检查,它们都使用了Sun官方定的规则。 -->
<!-- 局部的final变量,包括catch中的参数的检查 -->
<module name="LocalFinalVariableName" />
<!-- 局部的非final型的变量,包括catch中的参数的检查 -->
<module name="LocalVariableName" />
<!-- 包名的检查(只允许小写字母) -->
<module name="PackageName">
<property name="format" value="^[a-z]+(\.[a-z][a-z0-9]*)*$" />
</module>
<!-- 仅仅是static型的变量(不包括static final型)的检查 -->
<module name="StaticVariableName" />
<!-- 类型(Class或Interface)名的检查 -->
<module name="TypeName" />
<!-- 非static型变量的检查 -->
<module name="MemberName" />
<!-- 方法名的检查 -->
<module name="MethodName" />
<!-- 方法的参数名 -->
<module name="ParameterName " />
<!-- 常量名的检查 -->
<module name="ConstantName" />
<!-- 对区域的检查 -->
<!-- 不能出现空白区域 -->
<module name="EmptyBlock" />
<!-- 所有区域都要使用大括号。 -->
<module name="NeedBraces" />
<!-- 多余的括号 -->
<module name="AvoidNestedBlocks">
<property name="allowInSwitchCase" value="true" />
</module>
<!-- String的比较不能用!= 和 == -->
<module name="StringLiteralEquality" />
<!-- 同一行不能有多个声明 -->
<module name="MultipleVariableDeclarations" />
<!-- 不必要的圆括号 -->
<module name="UnnecessaryParentheses" />
<!-- 不能有main方法 -->
<module name="UncommentedMain">
<property name="excludedClasses" value="Application$" />
</module>
<!-- 检查并确保所有的常量中的L都是大写的。因为小写的字母l跟数字1太象了 -->
<module name="UpperEll" />
<!-- 检查数组类型的定义是String[] args,而不是String args[] -->
<module name="ArrayTypeStyle" />
<module name="MagicNumber">
<property name="tokens" value="NUM_DOUBLE, NUM_FLOAT" />
<property name="ignoreNumbers" value="0,1" />
<property name="ignoreAnnotation" value="true" />
</module>
</module>
</module>