mirror of
https://gitee.com/jmix/cuba.git
synced 2024-12-03 03:38:33 +08:00
330 lines
13 KiB
XML
330 lines
13 KiB
XML
<?xml version="1.0"?>
|
|
<!DOCTYPE module PUBLIC
|
|
"-//Puppy Crawl//DTD Check Configuration 1.3//EN"
|
|
"http://www.puppycrawl.com/dtds/configuration_1_3.dtd">
|
|
|
|
<!--
|
|
|
|
Checkstyle configuration that checks the sun coding conventions from:
|
|
|
|
- the Java Language Specification at
|
|
http://java.sun.com/docs/books/jls/second_edition/html/index.html
|
|
|
|
- the Sun Code Conventions at http://java.sun.com/docs/codeconv/
|
|
|
|
- the Javadoc guidelines at
|
|
http://java.sun.com/j2se/javadoc/writingdoccomments/index.html
|
|
|
|
- the JDK Api documentation http://java.sun.com/j2se/docs/api/index.html
|
|
|
|
- some best practices
|
|
|
|
Checkstyle is very configurable. Be sure to read the documentation at
|
|
http://checkstyle.sf.net (or in your downloaded distribution).
|
|
|
|
Most Checks are configurable, be sure to consult the documentation.
|
|
|
|
To completely disable a check, just comment it out or delete it from the file.
|
|
|
|
Finally, it is worth reading the documentation.
|
|
|
|
-->
|
|
|
|
<module name="Checker">
|
|
<!--
|
|
If you set the basedir property below, then all reported file
|
|
names will be relative to the specified directory. See
|
|
http://checkstyle.sourceforge.net/5.x/config.html#Checker
|
|
|
|
<property name="basedir" value="${basedir}"/>
|
|
-->
|
|
|
|
<module name="SuppressionFilter">
|
|
<property name="file" value="${checkstyleConfigDir}/suppressions.xml"/>
|
|
</module>
|
|
|
|
<!-- Checks that a package-info.java file exists for each package. -->
|
|
<!-- See http://checkstyle.sf.net/config_javadoc.html#JavadocPackage -->
|
|
<!--<module name="JavadocPackage">-->
|
|
<!--<property name="severity" value="warning"/>-->
|
|
<!--</module>-->
|
|
|
|
<!-- Checks whether files end with a new line. -->
|
|
<!-- See http://checkstyle.sf.net/config_misc.html#NewlineAtEndOfFile -->
|
|
<!--<module name="NewlineAtEndOfFile">-->
|
|
<!--<property name="severity" value="warning"/>-->
|
|
<!--</module>-->
|
|
|
|
<!-- Checks that property files contain the same keys. -->
|
|
<!-- See http://checkstyle.sf.net/config_misc.html#Translation -->
|
|
<!--<module name="Translation">-->
|
|
<!--<property name="severity" value="warning"/>-->
|
|
<!--</module>-->
|
|
|
|
<!-- Checks for Size Violations. -->
|
|
<!-- See http://checkstyle.sf.net/config_sizes.html -->
|
|
<module name="FileLength">
|
|
<property name="severity" value="warning"/>
|
|
</module>
|
|
|
|
<!-- Checks for whitespace -->
|
|
<!-- See http://checkstyle.sf.net/config_whitespace.html -->
|
|
<module name="FileTabCharacter">
|
|
<property name="severity" value="warning"/>
|
|
</module>
|
|
|
|
<!-- Miscellaneous other checks. -->
|
|
<!-- See http://checkstyle.sf.net/config_misc.html -->
|
|
<!--<module name="RegexpSingleline">-->
|
|
<!--<property name="format" value="\s+$"/>-->
|
|
<!--<property name="minimum" value="0"/>-->
|
|
<!--<property name="maximum" value="0"/>-->
|
|
<!--<property name="message" value="Line has trailing spaces."/>-->
|
|
<!--<property name="severity" value="warning"/>-->
|
|
<!--</module>-->
|
|
|
|
<module name="TreeWalker">
|
|
|
|
<!-- Checks for Javadoc comments. -->
|
|
<!-- See http://checkstyle.sf.net/config_javadoc.html -->
|
|
<module name="JavadocMethod">
|
|
<property name="severity" value="warning"/>
|
|
<property name="scope" value="public"/>
|
|
<property name="allowMissingPropertyJavadoc" value="true"/>
|
|
<property name="allowUndeclaredRTE" value="true"/>
|
|
<property name="allowMissingParamTags" value="true"/>
|
|
</module>
|
|
<module name="JavadocType">
|
|
<property name="severity" value="warning"/>
|
|
<property name="scope" value="public"/>
|
|
<property name="tokens" value="INTERFACE_DEF"/>
|
|
</module>
|
|
<!--<module name="JavadocVariable">-->
|
|
<!--<property name="severity" value="warning"/>-->
|
|
<!--</module>-->
|
|
<module name="JavadocStyle">
|
|
<property name="severity" value="warning"/>
|
|
</module>
|
|
|
|
|
|
<!-- Checks for Naming Conventions. -->
|
|
<!-- See http://checkstyle.sf.net/config_naming.html -->
|
|
<module name="ConstantName">
|
|
<property name="severity" value="warning"/>
|
|
</module>
|
|
<module name="LocalFinalVariableName">
|
|
<property name="severity" value="warning"/>
|
|
</module>
|
|
<module name="LocalVariableName">
|
|
<property name="severity" value="warning"/>
|
|
</module>
|
|
<module name="MemberName">
|
|
<property name="severity" value="warning"/>
|
|
</module>
|
|
<module name="MethodName">
|
|
<property name="severity" value="warning"/>
|
|
</module>
|
|
<module name="PackageName">
|
|
<property name="severity" value="warning"/>
|
|
</module>
|
|
<module name="ParameterName">
|
|
<property name="severity" value="warning"/>
|
|
</module>
|
|
<module name="StaticVariableName">
|
|
<property name="severity" value="warning"/>
|
|
</module>
|
|
<module name="TypeName">
|
|
<property name="severity" value="warning"/>
|
|
</module>
|
|
|
|
|
|
<!-- Checks for Headers -->
|
|
<!-- See http://checkstyle.sf.net/config_header.html -->
|
|
<!-- <module name="Header"> -->
|
|
<!-- The follow property value demonstrates the ability -->
|
|
<!-- to have access to ANT properties. In this case it uses -->
|
|
<!-- the ${basedir} property to allow Checkstyle to be run -->
|
|
<!-- from any directory within a project. See property -->
|
|
<!-- expansion, -->
|
|
<!-- http://checkstyle.sf.net/config.html#properties -->
|
|
<!-- <property -->
|
|
<!-- name="headerFile" -->
|
|
<!-- value="${basedir}/java.header"/> -->
|
|
<!-- </module> -->
|
|
|
|
<!-- Following interprets the header file as regular expressions. -->
|
|
<!-- <module name="RegexpHeader"/> -->
|
|
|
|
|
|
<!-- Checks for imports -->
|
|
<!-- See http://checkstyle.sf.net/config_import.html -->
|
|
<!--<module name="AvoidStarImport">-->
|
|
<!--<property name="severity" value="warning"/>-->
|
|
<!--</module>-->
|
|
<module name="IllegalImport">
|
|
<property name="severity" value="warning"/>
|
|
</module> <!-- defaults to sun.* packages -->
|
|
<module name="RedundantImport">
|
|
<property name="severity" value="warning"/>
|
|
</module>
|
|
<module name="UnusedImports">
|
|
<property name="severity" value="warning"/>
|
|
</module>
|
|
|
|
|
|
<!-- Checks for Size Violations. -->
|
|
<!-- See http://checkstyle.sf.net/config_sizes.html -->
|
|
<module name="LineLength">
|
|
<property name="severity" value="warning"/>
|
|
<property name="max" value="120"/>
|
|
</module>
|
|
<module name="MethodLength">
|
|
<property name="severity" value="warning"/>
|
|
</module>
|
|
<module name="ParameterNumber">
|
|
<property name="severity" value="warning"/>
|
|
</module>
|
|
|
|
|
|
<!-- Checks for whitespace -->
|
|
<!-- See http://checkstyle.sf.net/config_whitespace.html -->
|
|
<module name="EmptyForIteratorPad">
|
|
<property name="severity" value="warning"/>
|
|
</module>
|
|
<module name="GenericWhitespace">
|
|
<property name="severity" value="warning"/>
|
|
</module>
|
|
<module name="MethodParamPad">
|
|
<property name="severity" value="warning"/>
|
|
</module>
|
|
<module name="NoWhitespaceAfter">
|
|
<property name="severity" value="warning"/>
|
|
</module>
|
|
<module name="NoWhitespaceBefore">
|
|
<property name="severity" value="warning"/>
|
|
</module>
|
|
<module name="OperatorWrap">
|
|
<property name="severity" value="warning"/>
|
|
</module>
|
|
<module name="ParenPad">
|
|
<property name="severity" value="warning"/>
|
|
</module>
|
|
<module name="TypecastParenPad">
|
|
<property name="severity" value="warning"/>
|
|
</module>
|
|
<module name="WhitespaceAfter">
|
|
<property name="severity" value="warning"/>
|
|
</module>
|
|
<module name="WhitespaceAround">
|
|
<property name="severity" value="warning"/>
|
|
</module>
|
|
|
|
|
|
<!-- Modifier Checks -->
|
|
<!-- See http://checkstyle.sf.net/config_modifiers.html -->
|
|
<!--<module name="ModifierOrder">-->
|
|
<!--<property name="severity" value="warning"/>-->
|
|
<!--</module>-->
|
|
<module name="RedundantModifier">
|
|
<property name="severity" value="warning"/>
|
|
</module>
|
|
|
|
|
|
<!-- Checks for blocks. You know, those {}'s -->
|
|
<!-- See http://checkstyle.sf.net/config_blocks.html -->
|
|
<module name="AvoidNestedBlocks">
|
|
<property name="severity" value="warning"/>
|
|
</module>
|
|
<module name="EmptyBlock">
|
|
<property name="severity" value="warning"/>
|
|
</module>
|
|
<module name="LeftCurly">
|
|
<property name="severity" value="warning"/>
|
|
</module>
|
|
<module name="NeedBraces">
|
|
<property name="tokens" value="LITERAL_DO, LITERAL_FOR, LITERAL_WHILE"/>
|
|
<property name="severity" value="warning"/>
|
|
</module>
|
|
<module name="RightCurly">
|
|
<property name="severity" value="warning"/>
|
|
</module>
|
|
|
|
|
|
<!-- Checks for common coding problems -->
|
|
<!-- See http://checkstyle.sf.net/config_coding.html -->
|
|
<!--<module name="AvoidInlineConditionals">-->
|
|
<!--<property name="severity" value="warning"/>-->
|
|
<!--</module>-->
|
|
<module name="EmptyStatement">
|
|
<property name="severity" value="warning"/>
|
|
</module>
|
|
<module name="EqualsHashCode">
|
|
<property name="severity" value="warning"/>
|
|
</module>
|
|
<!--<module name="HiddenField">-->
|
|
<!--<property name="severity" value="warning"/>-->
|
|
<!--</module>-->
|
|
<module name="IllegalInstantiation">
|
|
<property name="severity" value="warning"/>
|
|
</module>
|
|
<module name="InnerAssignment">
|
|
<property name="severity" value="warning"/>
|
|
</module>
|
|
<!--<module name="MagicNumber">-->
|
|
<!--<property name="severity" value="warning"/>-->
|
|
<!--<property name="ignoreHashCodeMethod" value="true"/>-->
|
|
<!--<property name="ignoreAnnotation" value="true"/>-->
|
|
<!--</module>-->
|
|
<module name="MissingSwitchDefault">
|
|
<property name="severity" value="warning"/>
|
|
</module>
|
|
<module name="RedundantThrows">
|
|
<property name="severity" value="warning"/>
|
|
</module>
|
|
<module name="SimplifyBooleanExpression">
|
|
<property name="severity" value="warning"/>
|
|
</module>
|
|
<module name="SimplifyBooleanReturn">
|
|
<property name="severity" value="warning"/>
|
|
</module>
|
|
|
|
<!-- Checks for class design -->
|
|
<!-- See http://checkstyle.sf.net/config_design.html -->
|
|
<!--<module name="DesignForExtension">-->
|
|
<!--<property name="severity" value="warning"/>-->
|
|
<!--</module>-->
|
|
<module name="FinalClass">
|
|
<property name="severity" value="warning"/>
|
|
</module>
|
|
<module name="HideUtilityClassConstructor">
|
|
<property name="severity" value="warning"/>
|
|
</module>
|
|
<!--<module name="InterfaceIsType">-->
|
|
<!--<property name="severity" value="warning"/>-->
|
|
<!--</module>-->
|
|
<module name="VisibilityModifier">
|
|
<property name="severity" value="warning"/>
|
|
<property name="protectedAllowed" value="true"/>
|
|
<property name="packageAllowed" value="true"/>
|
|
</module>
|
|
|
|
|
|
<!-- Miscellaneous other checks. -->
|
|
<!-- See http://checkstyle.sf.net/config_misc.html -->
|
|
<module name="ArrayTypeStyle">
|
|
<property name="severity" value="warning"/>
|
|
</module>
|
|
<!--<module name="FinalParameters">-->
|
|
<!--<property name="severity" value="warning"/>-->
|
|
<!--</module>-->
|
|
<module name="TodoComment">
|
|
<property name="severity" value="warning"/>
|
|
</module>
|
|
<module name="UpperEll">
|
|
<property name="severity" value="warning"/>
|
|
</module>
|
|
|
|
</module>
|
|
|
|
</module>
|