Location via proxy:   [ UP ]  
[Report a bug]   [Manage cookies]                
Skip to content

Commit 92e119a

Browse files
fishercoder1534fishercoder1534
committed
add checkstyle xml file
1 parent bfec59f commit 92e119a

File tree

1 file changed

+208
-0
lines changed

1 file changed

+208
-0
lines changed

‎fishercoder_codestyle.xml

Lines changed: 208 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,208 @@
1+
<?xml version="1.0"?>
2+
<!DOCTYPE module PUBLIC
3+
"-//Puppy Crawl//DTD Check Configuration 1.3//EN"
4+
"http://www.puppycrawl.com/dtds/configuration_1_3.dtd">
5+
6+
<!--
7+
8+
Checkstyle configurartion that checks the Google coding conventions from:
9+
10+
- Google Java Style
11+
https://google-styleguide.googlecode.com/svn-history/r130/trunk/javaguide.html
12+
13+
Checkstyle is very configurable. Be sure to read the documentation at
14+
http://checkstyle.sf.net (or in your downloaded distribution).
15+
16+
Most Checks are configurable, be sure to consult the documentation.
17+
18+
To completely disable a check, just comment it out or delete it from the file.
19+
20+
Authors: Max Vetrenko, Ruslan Diachenko, Roman Ivanov.
21+
22+
-->
23+
24+
<module name = "Checker">
25+
<property name="charset" value="UTF-8"/>
26+
27+
<property name="severity" value="error"/>
28+
29+
<!-- Checks for whitespace -->
30+
<!-- See http://checkstyle.sf.net/config_whitespace.html -->
31+
<!--<module name="FileTabCharacter">
32+
<property name="eachLine" value="false"/>
33+
</module>-->
34+
35+
<module name="SuppressionCommentFilter">
36+
<property name="offCommentFormat" value="CHECKSTYLE_OFF\: ([\w\|]+)"/>
37+
<property name="onCommentFormat" value="CHECKSTYLE_OFF\: ([\w\|]+)"/>
38+
<property name="checkFormat" value="$1"/>
39+
</module>
40+
41+
<module name="TreeWalker">
42+
<property name="tabWidth" value="4"/>
43+
<module name="OuterTypeFilename"/>
44+
<!--<module name="IllegalTokenText">
45+
<property name="tokens" value="STRING_LITERAL, CHAR_LITERAL"/>
46+
<property name="format" value="\\u00(08|09|0(a|A)|0(c|C)|0(d|D)|22|27|5(C|c))|\\(0(10|11|12|14|15|42|47)|134)"/>
47+
<property name="message" value="Avoid using corresponding octal or Unicode escape."/>
48+
</module>
49+
<module name="AvoidEscapedUnicodeCharacters">
50+
<property name="allowEscapesForControlCharacters" value="true"/>
51+
<property name="allowByTailComment" value="true"/>
52+
<property name="allowNonPrintableEscapes" value="true"/>
53+
</module> -->
54+
<module name="LineLength">
55+
<property name="max" value="100"/>
56+
<property name="ignorePattern" value="^package.*|^import.*|a href|href|http://|https://|ftp://"/>
57+
</module>
58+
<!-- <module name="AvoidStarImport"/> -->
59+
<module name="OneTopLevelClass"/>
60+
<module name="NoLineWrap"/>
61+
<module name="EmptyBlock">
62+
<property name="option" value="TEXT"/>
63+
<property name="tokens" value="LITERAL_TRY, LITERAL_FINALLY, LITERAL_IF, LITERAL_ELSE, LITERAL_SWITCH"/>
64+
</module>
65+
<module name="NeedBraces"/>
66+
<module name="LeftCurly">
67+
<property name="maxLineLength" value="100"/>
68+
</module>
69+
<module name="RightCurly"/>
70+
<module name="RightCurly">
71+
<property name="option" value="alone"/>
72+
<property name="tokens" value="CLASS_DEF, METHOD_DEF, CTOR_DEF, LITERAL_FOR, LITERAL_WHILE, LITERAL_DO, STATIC_INIT, INSTANCE_INIT"/>
73+
</module>
74+
<module name="WhitespaceAround">
75+
<property name="allowEmptyConstructors" value="true"/>
76+
<property name="allowEmptyMethods" value="true"/>
77+
<property name="allowEmptyTypes" value="true"/>
78+
<property name="allowEmptyLoops" value="true"/>
79+
<message key="ws.notFollowed"
80+
value="WhitespaceAround: ''{0}'' is not followed by whitespace."/>
81+
<message key="ws.notPreceded"
82+
value="WhitespaceAround: ''{0}'' is not preceded with whitespace."/>
83+
</module>
84+
<module name="OneStatementPerLine"/>
85+
<module name="MultipleVariableDeclarations"/>
86+
<module name="ArrayTypeStyle"/>
87+
<module name="MissingSwitchDefault"/>
88+
<module name="FallThrough"/>
89+
<module name="UpperEll"/>
90+
<module name="ModifierOrder"/>
91+
<module name="EmptyLineSeparator">
92+
<property name="allowNoEmptyLineBetweenFields" value="true"/>
93+
</module>
94+
<module name="SeparatorWrap">
95+
<property name="tokens" value="DOT"/>
96+
<property name="option" value="nl"/>
97+
</module>
98+
<module name="SeparatorWrap">
99+
<property name="tokens" value="COMMA"/>
100+
<property name="option" value="EOL"/>
101+
</module>
102+
<module name="PackageName">
103+
<property name="format" value="^[a-z]+(\.[a-z][a-z0-9]*)*$"/>
104+
<message key="name.invalidPattern"
105+
value="Package name ''{0}'' must match pattern ''{1}''."/>
106+
</module>
107+
<module name="TypeName">
108+
<message key="name.invalidPattern"
109+
value="Type name ''{0}'' must match pattern ''{1}''."/>
110+
</module>
111+
<module name="MemberName">
112+
<property name="format" value="^[a-z][a-z0-9][a-zA-Z0-9]*$"/>
113+
<message key="name.invalidPattern"
114+
value="Member name ''{0}'' must match pattern ''{1}''."/>
115+
</module>
116+
<module name="ParameterName">
117+
<property name="format" value="^[a-z][a-zA-Z0-9]*$"/>
118+
<message key="name.invalidPattern"
119+
value="Parameter name ''{0}'' must match pattern ''{1}''."/>
120+
</module>
121+
<module name="LocalVariableName">
122+
<property name="tokens" value="VARIABLE_DEF"/>
123+
<property name="format" value="^[a-z][a-zA-Z0-9]*$"/>
124+
<property name="allowOneCharVarInForLoop" value="true"/>
125+
<message key="name.invalidPattern"
126+
value="Local variable name ''{0}'' must match pattern ''{1}''."/>
127+
</module>
128+
<module name="ClassTypeParameterName">
129+
<property name="format" value="(^[A-Z][0-9]?)$|([A-Z][a-zA-Z0-9]*[T]$)"/>
130+
<message key="name.invalidPattern"
131+
value="Class type name ''{0}'' must match pattern ''{1}''."/>
132+
</module>
133+
<module name="MethodTypeParameterName">
134+
<property name="format" value="(^[A-Z][0-9]?)$|([A-Z][a-zA-Z0-9]*[T]$)"/>
135+
<message key="name.invalidPattern"
136+
value="Method type name ''{0}'' must match pattern ''{1}''."/>
137+
</module>
138+
<module name="NoFinalizer"/>
139+
<module name="GenericWhitespace">
140+
<message key="ws.followed"
141+
value="GenericWhitespace ''{0}'' is followed by whitespace."/>
142+
<message key="ws.preceded"
143+
value="GenericWhitespace ''{0}'' is preceded with whitespace."/>
144+
<message key="ws.illegalFollow"
145+
value="GenericWhitespace ''{0}'' should followed by whitespace."/>
146+
<message key="ws.notPreceded"
147+
value="GenericWhitespace ''{0}'' is not preceded with whitespace."/>
148+
</module>
149+
<!--<module name="Indentation">
150+
<property name="basicOffset" value="4"/>
151+
<property name="braceAdjustment" value="0"/>
152+
<property name="caseIndent" value="4"/>
153+
<property name="throwsIndent" value="4"/>
154+
<property name="lineWrappingIndentation" value="4"/>
155+
<property name="arrayInitIndent" value="4"/>
156+
</module>-->
157+
<module name="AbbreviationAsWordInName">
158+
<property name="ignoreFinal" value="false"/>
159+
<property name="allowedAbbreviationLength" value="1"/>
160+
</module>
161+
<!--<module name="OverloadMethodsDeclarationOrder"/>-->
162+
<module name="VariableDeclarationUsageDistance">
163+
<property name="allowedDistance" value="10"/>
164+
</module>
165+
<module name="MethodParamPad"/>
166+
<module name="OperatorWrap">
167+
<property name="option" value="NL"/>
168+
<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 "/>
169+
</module>
170+
<!--<module name="AnnotationLocation">
171+
<property name="tokens" value="CLASS_DEF, INTERFACE_DEF, ENUM_DEF, METHOD_DEF, CTOR_DEF"/>
172+
</module>
173+
<module name="AnnotationLocation">
174+
<property name="tokens" value="VARIABLE_DEF"/>
175+
<property name="allowSamelineMultipleAnnotations" value="true"/>
176+
</module>
177+
<module name="NonEmptyAtclauseDescription"/>
178+
<module name="JavadocTagContinuationIndentation"/>
179+
<module name="SummaryJavadocCheck">
180+
<property name="forbiddenSummaryFragments" value="^@return the *|^This method returns |^A [{]@code [a-zA-Z0-9]+[}]( is a )"/>
181+
</module>
182+
<module name="JavadocParagraph"/>
183+
<module name="AtclauseOrder">
184+
<property name="tagOrder" value="@param, @return, @throws, @deprecated"/>
185+
<property name="target" value="CLASS_DEF, INTERFACE_DEF, ENUM_DEF, METHOD_DEF, CTOR_DEF, VARIABLE_DEF"/>
186+
</module>
187+
<module name="JavadocMethod">
188+
<property name="scope" value="public"/>
189+
<property name="allowMissingParamTags" value="true"/>
190+
<property name="allowMissingThrowsTags" value="true"/>
191+
<property name="allowMissingReturnTag" value="true"/>
192+
<property name="minLineCount" value="2"/>
193+
<property name="allowedAnnotations" value="Override, Test"/>
194+
<property name="allowThrowsTagsForSubclasses" value="true"/>
195+
</module>-->
196+
<module name="MethodName">
197+
<property name="format" value="^[a-z][a-z0-9][a-zA-Z0-9_]*$"/>
198+
<message key="name.invalidPattern"
199+
value="Method name ''{0}'' must match pattern ''{1}''."/>
200+
</module>
201+
<module name="MethodLength">
202+
<property name="tokens" value="METHOD_DEF"/>
203+
<property name="max" value="100"/>
204+
<property name="countEmpty" value="false"/>
205+
</module>
206+
<!--<module name="SingleLineJavadoc"/> -->
207+
</module>
208+
</module>

0 commit comments

Comments
 (0)