Skip to content

Commit 1fad609

Browse files
yu199195yu199195
committed
add checkStyle and gitignore
1 parent d259c89 commit 1fad609

2 files changed

Lines changed: 276 additions & 0 deletions

File tree

‎.gitignore‎

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
# Mobile Tools for Java (J2ME)
2+
.mtj.tmp/
3+
4+
# Package Files #
5+
*.jar
6+
*.war
7+
*.ear
8+
9+
# virtual machine crash logs, see http://www.java.com/en/download/help/error_hotspot.xml
10+
hs_err_pid*
11+
12+
*~
13+
14+
# eclipse ignore
15+
.settings
16+
.project
17+
.classpath
18+
.tomcatplugin
19+
logPath_IS_UNDEFINED
20+
*.gz
21+
disconf
22+
23+
# idea ignore
24+
.idea
25+
*.iml
26+
27+
# maven ignore
28+
target
29+
30+
# other ignore
31+
*.log
32+
*.tmp
33+
Thumbs.db
34+
*.DS_Store

‎lcn_checks.xml‎

Lines changed: 242 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,242 @@
1+
<?xml version="1.0"?>
2+
<!DOCTYPE module PUBLIC "-//Puppy Crawl//DTD Check Configuration 1.3//EN" "http://checkstyle.sourceforge.net/dtds/configuration_1_3.dtd">
3+
<module name = "Checker">
4+
<property name="charset" value="UTF-8"/>
5+
<property name="severity" value="warning"/>
6+
<property name="fileExtensions" value="java, properties, xml"/>
7+
<module name="Header">
8+
<property name="headerFile" value="copyright.txt"/>
9+
<property name="fileExtensions" value="java"/>
10+
</module>
11+
<module name="FileTabCharacter">
12+
<property name="eachLine" value="true"/>
13+
</module>
14+
<module name="FileLength"/>
15+
<module name="NewlineAtEndOfFile">
16+
<property name="lineSeparator" value="lf"/>
17+
</module>
18+
<module name="Translation"/>
19+
<module name="UniqueProperties"/>
20+
<module name="SeverityMatchFilter"/>
21+
22+
<module name="TreeWalker">
23+
24+
<!-- Naming Conventions -->
25+
<module name="PackageName">
26+
<property name="format" value="^[a-z]+(\.[a-z][a-z0-9]*)*$"/>
27+
</module>
28+
<module name="TypeName"/>
29+
<module name="MethodName"/>
30+
<module name="InterfaceTypeParameterName"/>
31+
<module name="ClassTypeParameterName"/>
32+
<module name="MethodTypeParameterName"/>
33+
<module name="ConstantName"/>
34+
<module name="StaticVariableName"/>
35+
<module name="MemberName"/>
36+
<module name="LocalVariableName"/>
37+
<module name="LocalFinalVariableName"/>
38+
<module name="ParameterName"/>
39+
<module name="CatchParameterName"/>
40+
<module name="AbbreviationAsWordInName">
41+
<property name="allowedAbbreviationLength" value="6"/>
42+
</module>
43+
44+
<!-- Size Violations -->
45+
<module name="AnonInnerLength"/>
46+
<module name="MethodLength"/>
47+
<module name="LineLength">
48+
<property name="max" value="200"/>
49+
</module>
50+
<module name="MethodCount"/>
51+
<module name="ExecutableStatementCount">
52+
<property name="max" value="50"/>
53+
</module>
54+
<module name="OuterTypeNumber"/>
55+
<module name="ParameterNumber"/>
56+
57+
<!-- Whitespace -->
58+
<module name="EmptyForInitializerPad"/>
59+
<module name="EmptyForIteratorPad"/>
60+
<module name="MethodParamPad"/>
61+
<module name="ParenPad"/>
62+
<module name="TypecastParenPad"/>
63+
<module name="NoLineWrap"/>
64+
<module name="OperatorWrap"/>
65+
<module name="SeparatorWrap">
66+
<property name="id" value="SeparatorWrapDot"/>
67+
<property name="tokens" value="DOT"/>
68+
<property name="option" value="nl"/>
69+
</module>
70+
<module name="SeparatorWrap">
71+
<property name="id" value="SeparatorWrapComma"/>
72+
<property name="tokens" value="COMMA"/>
73+
<property name="option" value="EOL"/>
74+
</module>
75+
<module name="SeparatorWrap">
76+
<property name="id" value="SeparatorWrapEllipsis"/>
77+
<property name="tokens" value="ELLIPSIS"/>
78+
<property name="option" value="EOL"/>
79+
</module>
80+
<module name="SeparatorWrap">
81+
<property name="id" value="SeparatorWrapArrayDeclarator"/>
82+
<property name="tokens" value="ARRAY_DECLARATOR"/>
83+
<property name="option" value="EOL"/>
84+
</module>
85+
<module name="SeparatorWrap">
86+
<property name="id" value="SeparatorWrapMethodRef"/>
87+
<property name="tokens" value="METHOD_REF"/>
88+
<property name="option" value="nl"/>
89+
</module>
90+
<module name="GenericWhitespace"/>
91+
<module name="NoWhitespaceBefore"/>
92+
<module name="NoWhitespaceAfter"/>
93+
<module name="WhitespaceAround"/>
94+
<module name="WhitespaceAfter"/>
95+
<module name="SingleSpaceSeparator"/>
96+
<module name="EmptyLineSeparator">
97+
<property name="allowMultipleEmptyLines" value="false"/>
98+
<property name="allowMultipleEmptyLinesInsideClassMembers" value="false"/>
99+
</module>
100+
101+
<!-- Imports -->
102+
<module name="AvoidStarImport"/>
103+
<module name="AvoidStaticImport">
104+
<property name="excludes" value="org.junit.Assert.*,org.hamcrest.CoreMatchers.*,org.mockito.Mockito.*"/>
105+
</module>
106+
<module name="IllegalImport"/>
107+
<module name="RedundantImport"/>
108+
<module name="UnusedImports"/>
109+
<module name="CustomImportOrder"/>
110+
111+
<!-- Annotations -->
112+
<module name="AnnotationLocation">
113+
<property name="id" value="AnnotationLocationMostCases"/>
114+
<property name="tokens" value="CLASS_DEF, INTERFACE_DEF, ENUM_DEF, METHOD_DEF, CTOR_DEF"/>
115+
</module>
116+
<module name="AnnotationLocation">
117+
<property name="id" value="AnnotationLocationVariables"/>
118+
<property name="tokens" value="VARIABLE_DEF"/>
119+
<property name="allowSamelineMultipleAnnotations" value="true"/>
120+
</module>
121+
<module name="AnnotationUseStyle"/>
122+
<module name="MissingOverride"/>
123+
<module name="SuppressWarnings"/>
124+
<module name="MissingDeprecated"/>
125+
<module name="SuppressWarningsHolder"/>
126+
127+
<!-- Modifiers -->
128+
<module name="ModifierOrder"/>
129+
<module name="RedundantModifier"/>
130+
131+
<!-- Coding -->
132+
<module name="ArrayTrailingComma"/>
133+
<module name="CovariantEquals"/>
134+
<module name="DefaultComesLast"/>
135+
<module name="DeclarationOrder"/>
136+
<module name="EmptyStatement"/>
137+
<module name="EqualsAvoidNull"/>
138+
<module name="EqualsHashCode"/>
139+
<module name="ExplicitInitialization"/>
140+
<module name="FallThrough"/>
141+
<module name="IllegalInstantiation"/>
142+
<module name="IllegalCatch"/>
143+
<module name="IllegalThrows"/>
144+
<module name="IllegalType">
145+
<property name="tokens" value="METHOD_DEF,PARAMETER_DEF,VARIABLE_DEF"/>
146+
</module>
147+
<module name="IllegalTokenText">
148+
<property name="tokens" value="STRING_LITERAL, CHAR_LITERAL"/>
149+
<property name="format" value="\\u00(09|0(a|A)|0(c|C)|0(d|D)|22|27|5(C|c))|\\(0(10|11|12|14|15|42|47)|134)"/>
150+
<property name="message" value="Consider using special escape sequence instead of octal value or Unicode escaped value."/>
151+
</module>
152+
<module name="MissingSwitchDefault"/>
153+
<module name="ModifiedControlVariable"/>
154+
<module name="MultipleVariableDeclarations"/>
155+
<module name="NestedForDepth"/>
156+
<module name="NestedIfDepth"/>
157+
<module name="NestedTryDepth"/>
158+
<module name="NoClone"/>
159+
<module name="NoFinalizer"/>
160+
<module name="SuperClone"/>
161+
<module name="SuperFinalize"/>
162+
<module name="OneStatementPerLine"/>
163+
<module name="OverloadMethodsDeclarationOrder"/>
164+
<module name="PackageDeclaration"/>
165+
<module name="ParameterAssignment"/>
166+
<module name="SimplifyBooleanExpression"/>
167+
<module name="SimplifyBooleanReturn"/>
168+
<module name="StringLiteralEquality"/>
169+
<module name="UnnecessaryParentheses"/>
170+
<module name="VariableDeclarationUsageDistance"/>
171+
172+
<!-- Block Checks -->
173+
<module name="EmptyBlock"/>
174+
<module name="EmptyCatchBlock">
175+
<property name="exceptionVariableName" value="expected|ignore"/>
176+
</module>
177+
<module name="AvoidNestedBlocks"/>
178+
<module name="NeedBraces"/>
179+
<module name="LeftCurly"/>
180+
<module name="RightCurly"/>
181+
182+
<!-- Class Design -->
183+
<!-- <module name="DesignForExtension"/> -->
184+
<module name="FinalClass"/>
185+
<module name="OneTopLevelClass"/>
186+
<module name="InterfaceIsType"/>
187+
<module name="InnerTypeLast"/>
188+
<module name="VisibilityModifier"/>
189+
<module name="MutableException"/>
190+
<module name="ThrowsCount"/>
191+
192+
<!-- Metrics -->
193+
<module name="BooleanExpressionComplexity"/>
194+
<module name="ClassDataAbstractionCoupling">
195+
<property name="max" value="10"/>
196+
</module>
197+
<module name="ClassFanOutComplexity"/>
198+
<module name="CyclomaticComplexity"/>
199+
<module name="NPathComplexity"/>
200+
<module name="JavaNCSS"/>
201+
202+
<!-- Miscellaneous -->
203+
<module name="ArrayTypeStyle"/>
204+
<module name="UpperEll"/>
205+
<module name="AvoidEscapedUnicodeCharacters"/>
206+
<module name="DescendantToken"/>
207+
<module name="FinalParameters"/>
208+
<module name="Indentation"/>
209+
<module name="OuterTypeFilename"/>
210+
<module name="TodoComment"/>
211+
<module name="TrailingComment"/>
212+
<module name="UncommentedMain">
213+
<property name="excludedClasses" value="\.Bootstrap"/>
214+
</module>
215+
216+
<!-- Javadoc Comments -->
217+
<module name="AtclauseOrder">
218+
<property name="tagOrder" value="@author, @param, @return, @throws, @deprecated"/>
219+
</module>
220+
<module name="NonEmptyAtclauseDescription"/>
221+
<module name="JavadocParagraph"/>
222+
<module name="JavadocStyle"/>
223+
<module name="JavadocTagContinuationIndentation"/>
224+
<module name="SingleLineJavadoc"/>
225+
<module name="SummaryJavadoc"/>
226+
<!--
227+
<module name="JavadocType">
228+
<property name="scope" value="public"/>
229+
</module>
230+
-->
231+
<module name="JavadocMethod">
232+
<property name="scope" value="public"/>
233+
<property name="allowedAnnotations" value="Override, Test, Before, After, BeforeClass, AfterClass, Parameterized, Parameters"/>
234+
<property name="ignoreMethodNamesRegex" value="^assert.*$|^verify.*$"/>
235+
<property name="tokens" value="METHOD_DEF, ANNOTATION_FIELD_DEF"/>
236+
</module>
237+
238+
<!-- Filters -->
239+
<module name="SuppressionCommentFilter"/>
240+
<module name="SuppressWithNearbyCommentFilter"/>
241+
</module>
242+
</module>

0 commit comments

Comments
 (0)