Checkstyle使用参考

男娘i 2022-04-10 10:11 575阅读 0赞

Checkstyle使用参考

# 一、Checkstyle简介 #

Checkstyle 是一个帮助开发者按照某种习惯编写 java 代码的工具，他实现了代码检查的自动化，帮助人们从这种繁琐的工作中解放出来。

默认提供了对 sun 编程规范的支持，但是 Checkstyle 是一个具有高可配置性的，你完全可以根据自己的要求来配置需要检查的内容。

# 二、Checkstyle+Ant #

## 1 下载安装 ##

### 1.1 Ant的下载安装 ###

下载apache-ant-1.6.5-bin.zip，然后解压缩到C:/apache-ant-1.6.5（或其它路径下）。

添加新的环境变量ANT\_HOME

![o_e6_9c_aa_e5_91_bd_e5_90_8d-9.gif][]

添加新的变量值到环境变量Path中

![o_e6_9c_aa_e5_91_bd_e5_90_8d-10.gif][]

在Dos窗口下输入ant回车，如果看到下图的内容，说明Ant已经成功安装了。

![o_e6_9c_aa_e5_91_bd_e5_90_8d-8.gif][]

如果没看到上图的信息，请根据运行环境的实际情况检查下列信息

ANT\_HOME = C:/apache-ant-1.6.5

JAVA\_HOME = C:/j2sdk1.4.2\_08

Path = %ANT\_HOME%/bin;%JAVA\_HOME%/bin;(后面还有很多，这里就省略了)

ClASSPATH = .;%JAVA\_HOME%/jre/lib/rt.jar;%JAVA\_HOME%/lib/tools.jar

(注意上面一行等号后面是个点“**.**”　后面接分号)

### 1.2 Checkstyle的下载安装 ###

下载checkstyle-4.2.zip，然后解压缩到C:/checkstyle-4.2（或其它路径下），下文提到这个路径时将使用CHECKSTYLE\_HOME代替。

将CHECKSTYLE\_HOME目录下的checkstyle-optional-4.2.jar拷贝到ANT\_HOME/lib目录下

## 2．使用Ant实现代码检查 ##

使用Ant实现代码检查，我们共需要三个文件build.xml, user.properties和sunrising\_checks.xml，下面分别对讲解这三个文件。

### 2.1 user.properties ###

这个文件是将要在build.xml中用的属性文件，用户可以自定义下面的常用的属性

<table style="background:#e6e6e6"> 
 <tbody> 
 <tr> 
 <td> # 项目名称 project.name=TopShelf &nbsp; # 项目所在的路径 project.dir=F/://eclipse//WorkSpace20061012//WordEmTest &nbsp; # 源文件所在的路径 project.src.dir=${project.dir}//src &nbsp; # 报告生成的位置, 默认的位置为${project.dir}//report # 如果需要在其它位置生成报告, 请删除下面一行前面的"#",并且在等号后面给出路径 # project.checkstyle.report.dir=new path here &nbsp; # 检测结果文件名, 默认为${project.name}-checkstyle-result-${DSTAMP}.xml # 如果需要在改成其它的文件名, 请删除下面一行前面的"#",并且在等号后面给出新的文件名 # project.check.result.name=new name here &nbsp; # 检测报告文件名, 默认为${project.name}-checkstyle-report-${DSTAMP}.html # 如果需要在改成其它的文件名, 请删除下面一行前面的"#",并且在等号后面给出新的文件名 # project.check.report.name=new name here &nbsp; # checkstyle的配置文件, 默认的配置文件为${basedir}/sunrising_checks.xml # 如果需要使用其它的配置文件, 请删除下面一行前面的"#",并且在等号后面给出配置文件的路径 # checkstyle.config=new path here &nbsp; # checkstyle的报告风格, 默认值为${basedir}/contrib/checkstyle-noframes.xsl # checkstyle.report.style=new style here </td> 
 </tr> 
 </tbody> 
</table>

### 2.2 build.xml ###

这个文件是运行Ant时需要用的文件

<table> 
 <tbody> 
 <tr> 
 <td style="background:#e6e6e6"> &lt;project name="checkstyle" default="checkstyle" basedir="."&gt; 　　&lt;!-- 导入属性文件 --&gt; &nbsp;&nbsp;&nbsp; &lt;property file="user.properties" /&gt; &nbsp;&nbsp;&nbsp; &lt;target name="init"&gt; &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; &lt;tstamp/&gt; &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; &lt;!-- 报告的生成位置 --&gt; &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; &lt;property name="project.checkstyle.report.dir" value="${project.dir}/report"/&gt; &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; &lt;!-- 检测结果的文件名 --&gt; &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; &lt;property name="project.check.result.name" value="${project.name}-checkstyle-result-${DSTAMP}.xml"/&gt; &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; &lt;!-- 检测报告的文件名 --&gt; &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; &lt;property name="project.check.report.name" value="${project.name}-checkstyle-report-${DSTAMP}.html"/&gt; &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; &lt;!-- 所使用的配置文件 --&gt; &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; &lt;property name="checkstyle.config" value="${basedir}/sunrising_checks.xml"/&gt; &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; &lt;!-- 报告风格 --&gt; &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; &lt;property name="checkstyle.report.style" value="${basedir}/contrib/checkstyle-noframes.xsl"/&gt; &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; &lt;!-- 检测结果 --&gt; &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; &lt;property name="checkstyle.result" value="${project.checkstyle.report.dir}/${project.check.result.name}"/&gt; &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; &lt;!-- 检测报告 --&gt; &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; &lt;property name="checkstyle.report" value="${project.checkstyle.report.dir}/${project.check.report.name}"/&gt; &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; &lt;!-- 新建报告所在的文件夹 --&gt; &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; &lt;mkdir dir="${project.checkstyle.report.dir}" /&gt; &nbsp;&nbsp;&nbsp; &lt;/target&gt; &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; &nbsp;&nbsp;&nbsp; &lt;taskdef resource="checkstyletask.properties" classpath="${basedir}/checkstyle-all-4.2.jar" /&gt;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; &nbsp;&nbsp;&nbsp; &lt;target name="checkstyle" depends="init" description="Check java code and report "&gt; &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; &lt;!-- failOnViolation: 检测到问题时是否停止 --&gt; &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; &lt;!-- failureProperty: 是否有问题, 这个参数在此暂没有用到 --&gt; &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; &lt;!-- See CHECKSTYLE_HOME/docs/anttask.html --&gt; &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; &lt;checkstyle config="${checkstyle.config}" failOnViolation="false" failureProperty="checkstyle.failure"&gt; &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; &lt;formatter type="xml" tofile="${checkstyle.result}"/&gt; &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; &lt;fileset dir="${project.src.dir}" includes="**/*.java"/&gt; &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; &lt;/checkstyle&gt; &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; &lt;!-- 生成报告,其格式取决于${checkstyle.report.style} --&gt; &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; &lt;style in="${checkstyle.result}" out="${checkstyle.report}" style="${checkstyle.report.style}"/&gt; &nbsp;&nbsp;&nbsp; &lt;/target&gt; &lt;/project&gt; </td> 
 </tr> 
 </tbody> 
</table>

### 2.3 sunrising\_checks.xml ###

这个文件是Checkstyle在执行代码检测时需要用的配置文件，里面定义的检查规则。详细的规则定义将在第四节做详细介绍。

### 2.4 执行步骤 ###

A)      将上面提到的三个文件拷贝到CHECKSTYLE\_HOME目录下

B)      打开DOS窗口进入到CHECKSTYLE\_HOME目录下

![o_e6_9c_aa_e5_91_bd_e5_90_8d-12.gif][]

C)      输入ant，然后回车，如果能看到BUILD SUCCESSFUL就成功了。

![o_e6_9c_aa_e5_91_bd_e5_90_8d-13.gif][]

# 三、Checkstyle+Eclipse #

## 1 安装Checkstyle的Eclipse的插件 ##

A)      首选下载Checkstyle的Eclipse的插件－com.atlassw.tools.eclipse.checkstyle\_4.1.1-bin.zip

B)      将插件解压缩后，将features和plugins和文件夹中的内容拷贝到Eclipse下对应的文件夹下

C)      删除ECLIPSE\_HOME/configuration/下的org.eclipse.update文件夹，然后重新启动Eclipse

## 2 在Eclipse中使用Checkstyle ##

A)      插件安装成功后，在Eclipse中点击Window->Preferences选项可以看到下图

![o_Image00001.gif][]

B)      在项目上使用Checkstyle。右键单击项目，选择Properties选项后可以看到下图

![o_e6_9c_aa_e5_91_bd_e5_90_8d-4.gif][]

1)         选择Checkstyle

2)         选中Check Box－Checkstyle active for this project

3)         从下拉列表中选择一个Checkstyle的配置文件

4)         点击OK

查看项目中的任意一个源文件，可以看到类似下图的情况：

![o_e6_9c_aa_e5_91_bd_e5_90_8d-5.gif][]

将鼠标指向图中的放大镜处稍做停留便可看到提示信息，如图片中的”Missing a Javadoc comment.”

# 四、Checkstyle配置文件的简要说明 #

关于配置文件的各个模块的更多细节，请参考CHECKSTYLE\_HOME/docs/index.html

<table style="background:#e6e6e6"> 
 <tbody> 
 <tr> 
 <td> &lt;?xml version="1.0" encoding="UTF-8"?&gt; &lt;!DOCTYPE module PUBLIC "-//Puppy Crawl//DTD Check Configuration 1.2//EN" "http://www.puppycrawl.com/dtds/configuration_1_2.dtd"&gt; &lt;!-- 对于所有的模块来书,如果有这个模块则说明检测这一项,没有则不检测这一项 --&gt; &lt;!-- 所有的模块中,其ROOT必须为Checker --&gt; &lt;module name="Checker"&gt; &lt;!-- 检验每个包是否存在package.html文件--&gt; &lt;!-- See http://checkstyle.sf.net/config_javadoc.html#PackageHtml --&gt; &lt;!-- &lt;module name="PackageHtml"/&gt; --&gt; &lt;!-- 检验每个文件末尾是否有一个空行--&gt; &lt;!-- See http://checkstyle.sf.net/config_misc.html#NewlineAtEndOfFile --&gt; &lt;!-- &lt;module name="NewlineAtEndOfFile"/&gt; --&gt; &lt;!-- Checks that property files contain the same keys. --&gt; &lt;!-- See http://checkstyle.sf.net/config_misc.html#Translation --&gt; &lt;module name="Translation"/&gt; &lt;module name="TreeWalker"&gt; &lt;!-- Checks for Javadoc comments. --&gt; &lt;!-- See http://checkstyle.sf.net/config_javadoc.html --&gt; &lt;!-- Checks Javadoc comments for method definitions.--&gt; &lt;module name="JavadocMethod"&gt; &lt;property name="scope" value="public"/&gt; &lt;!-- 是否允许错误的参数声明,true为允许,缺省为不允许 --&gt; &lt;property name="allowMissingParamTags" value="true"/&gt; &lt;!-- 是否允许错误的错误声明,true为允许,缺省为不允许 --&gt; &lt;property name="allowMissingThrowsTags" value="true"/&gt; &lt;!-- 是否允许错误的返回类型声明,true为允许,缺省为不允许 --&gt; &lt;property name="allowMissingReturnTag" value="true"/&gt; &lt;/module&gt; &lt;!--Checks Javadoc comments for class and interface definitions.--&gt; &lt;module name="JavadocType"/&gt; &lt;!-- Checks that variables have Javadoc comments.--&gt; &lt;module name="JavadocVariable"&gt; &lt;property name="scope" value="protected"/&gt; &lt;/module&gt; &lt;!-- 检查Javadoc的格式 --&gt; &lt;module name="JavadocStyle"&gt; &lt;property name="scope" value="public"/&gt; &lt;!-- Comment的第一句的末尾是否要有一个句号,true必须有,default为true --&gt; &lt;property name="checkFirstSentence" value="false"/&gt; &lt;!-- 检查错误的HTML脚本,比如不匹配,true检查,default为true --&gt; &lt;property name="checkHtml" value="true"/&gt; &lt;/module&gt; &lt;!-- Checks for Naming Conventions. --&gt; &lt;!-- See http://checkstyle.sf.net/config_naming.html --&gt; &lt;!-- 确省必须以Abstract开始或者以Factory结束 --&gt; &lt;!-- &lt;module name="AbstractClassName"/&gt; --&gt; &lt;module name="ConstantName"/&gt; &lt;module name="LocalFinalVariableName"/&gt; &lt;module name="LocalVariableName"/&gt; &lt;module name="MemberName"/&gt; &lt;module name="MethodName"/&gt; &lt;module name="PackageName"/&gt; &lt;module name="ParameterName"/&gt; &lt;module name="StaticVariableName"/&gt; &lt;module name="TypeName"/&gt; &lt;!-- Checks for Headers --&gt; &lt;!-- See http://checkstyle.sf.net/config_header.html --&gt; &lt;!-- 检查文件是否以指定文件开始,这里最好是放一些版权信息和工程描述 --&gt; &lt;!-- headerFile:指定的文件 --&gt; &lt;!-- ignoreLines:忽略哪些行,以","分隔 --&gt; &lt;!-- &lt;module name="Header"&gt; &lt;property name="headerFile" value="java.header"/&gt; &lt;property name="ignoreLines" value="2, 3, 4, 5"/&gt; &lt;/module&gt; --&gt; &lt;!-- Following interprets the header file as regular expressions. --&gt; &lt;!-- &lt;module name="RegexpHeader"/&gt; --&gt; &lt;!-- Checks for imports --&gt; &lt;!-- See http://checkstyle.sf.net/config_import.html --&gt; &lt;!-- 检查使用*号的导入,默认为全部类 --&gt; &lt;module name="AvoidStarImport"/&gt; &lt;!-- 检查是否有非法的包,确省检查sun.*;对于某些包是不建议直接调用的 --&gt; &lt;module name="IllegalImport"&gt; &lt;property name="illegalPkgs" value="sun.*"/&gt; &lt;/module&gt; &lt;!-- 检查多于的导入,如一个类导入了多次 --&gt; &lt;module name="RedundantImport"/&gt; &lt;!-- 检查没有使用的导入 --&gt; &lt;module name="UnusedImports"/&gt; &lt;!-- 导入排序 --&gt; &lt;!-- groups:分组,哪些是一组的 --&gt; &lt;!-- ordered:同一个组内是否排序,true排序,确省为true --&gt; &lt;!-- separated:各个组之间是否需要用空行分隔,确省为false --&gt; &lt;!-- caseSensitive:是否是大小写敏感的,确省是 --&gt; &lt;!-- &lt;module name="ImportOrder"&gt; &lt;property name="groups" value="java,javax"/&gt; &lt;property name="ordered" value="true"/&gt; &lt;property name="separated" value="true"/&gt; &lt;property name="caseSensitive" value="true"/&gt; &lt;/module&gt; --&gt; &lt;!-- Checks for Size Violations. --&gt; &lt;!-- See http://checkstyle.sf.net/config_sizes.html --&gt; &lt;!-- 检查方法内可执行语句的个数,确省为30行 --&gt; &lt;!-- &lt;module name="ExecutableStatementCount"&gt; &lt;property name="max" value="30"/&gt; &lt;/module&gt; --&gt; &lt;!-- 文件的最大行数,缺省为1500 --&gt; &lt;module name="FileLength"&gt; &lt;property name="max" value="2000"/&gt; &lt;/module&gt; &lt;!-- 每行的最大字符数,缺省为80 --&gt; &lt;module name="LineLength"&gt; &lt;!-- 忽略指定格式的行,如*号开始的,等 --&gt; &lt;!-- &lt;property name="ignorePattern" value="^ */* *[^ ]+$"/&gt; --&gt; &lt;property name="max" value="120"/&gt; &lt;/module&gt; &lt;!-- 方法的最大行数,缺省为150 --&gt; &lt;module name="MethodLength"&gt; &lt;property name="max" value="200"/&gt; &lt;!-- 统计时是否包括空行和以//开始的注释,缺省为统计(true)--&gt; &lt;property name="countEmpty" value="false"/&gt; &lt;/module&gt; &lt;!-- 匿名类的最大行数,缺省为20 --&gt; &lt;module name="AnonInnerLength"&gt; &lt;property name="max" value="60"/&gt; &lt;/module&gt; &lt;!-- 检查方法和构造子参数的最大个数,缺省为7 --&gt; &lt;module name="ParameterNumber"/&gt; &lt;!-- Checks for whitespace --&gt; &lt;!-- See http://checkstyle.sf.net/config_whitespace.html --&gt; &lt;module name="EmptyForInitializerPad"/&gt; &lt;module name="EmptyForIteratorPad"/&gt; &lt;module name="MethodParamPad"&gt; &lt;property name="allowLineBreaks" value="true"/&gt; &lt;/module&gt; &lt;module name="NoWhitespaceAfter"/&gt; &lt;module name="NoWhitespaceBefore"/&gt; &lt;module name="OperatorWrap"/&gt; &lt;module name="ParenPad"/&gt; &lt;module name="TypecastParenPad"/&gt; &lt;module name="TabCharacter"/&gt; &lt;module name="WhitespaceAfter"/&gt; &lt;module name="WhitespaceAround"/&gt; &lt;!-- Modifier Checks --&gt; &lt;!-- See http://checkstyle.sf.net/config_modifiers.html --&gt; &lt;!-- 要求JLS suggestions --&gt; &lt;!-- &lt;module name="ModifierOrder"/&gt; --&gt; &lt;module name="RedundantModifier"/&gt; &lt;!-- Checks for blocks. You know, those {}'s --&gt; &lt;!-- See http://checkstyle.sf.net/config_blocks.html --&gt; &lt;!-- 检查空块 --&gt; &lt;!-- &lt;module name="EmptyBlock"/&gt; --&gt; &lt;module name="LeftCurly"/&gt; &lt;!-- 检查只有必须有{},确省为必须,主要在if,else时有这样的情况 --&gt; &lt;module name="NeedBraces"/&gt; &lt;!-- 检查"}",确省在同一行 --&gt; &lt;module name="RightCurly"&gt; &lt;property name="option" value="alone"/&gt; &lt;/module&gt; &lt;!-- 检查多余嵌套的{},请看文档,不易说明 --&gt; &lt;module name="AvoidNestedBlocks"/&gt; &lt;!-- Checks for common coding problems --&gt; &lt;!-- See http://checkstyle.sf.net/config_coding.html --&gt; &lt;module name="AvoidInlineConditionals"/&gt; &lt;module name="CovariantEquals"/&gt; &lt;module name="DeclarationOrder"/&gt; &lt;module name="DefaultComesLast"/&gt; &lt;module name="DoubleCheckedLocking"/&gt; &lt;!-- &lt;module name="EmptyStatement"/&gt; --&gt; &lt;module name="EqualsHashCode"/&gt; &lt;!-- 变量必须初始化为自己的类型,如果给一个Object类型的变量初始化为null会提示 --&gt; &lt;!-- &lt;module name="ExplicitInitialization"/&gt; --&gt; &lt;module name="FallThrough"/&gt; &lt;!-- &lt;module name="FinalLocalVariable"/&gt; --&gt; &lt;module name="HiddenField"&gt; &lt;property name="ignoreConstructorParameter" value="true"/&gt; &lt;property name="ignoreSetter" value="true"/&gt; &lt;/module&gt; &lt;!-- Exception, Throwable, RuntimeException是不允许catch的 --&gt; &lt;!-- &lt;module name="IllegalCatch"/&gt; --&gt; &lt;module name="IllegalInstantiation"/&gt; &lt;!-- &lt;module name="IllegalToken"/&gt; --&gt; &lt;module name="IllegalTokenText"/&gt; &lt;module name="IllegalType"/&gt; &lt;module name="InnerAssignment"/&gt; &lt;!--检查直接数 &lt;module name="MagicNumber"/&gt; 检查是否有构造子 &lt;module name="MissingCtor"/&gt; --&gt; &lt;module name="MissingSwitchDefault"/&gt; &lt;module name="MultipleVariableDeclarations"/&gt; &lt;!-- &lt;module name="JUnitTestCase"/&gt; &lt;module name="NestedIfDepth""&gt; &lt;property name="max" value="5"/&gt; &lt;/module&gt; &lt;module name="NestedTryDepth""&gt; &lt;property name="max" value="5"/&gt; &lt;/module&gt; &lt;module name="PackageDeclaration"/&gt; &lt;module name="ReturnCount"/&gt; --&gt; &lt;!-- 不能为参数付值 --&gt; &lt;!-- &lt;module name="ParameterAssignment"/&gt; --&gt; &lt;module name="RedundantThrows"/&gt; &lt;!-- 不能理解的,好像是bug &lt;module name="RequireThis"/&gt; --&gt; &lt;module name="SimplifyBooleanExpression"/&gt; &lt;module name="SimplifyBooleanReturn"/&gt; &lt;module name="StringLiteralEquality"/&gt; &lt;module name="SuperClone"/&gt; &lt;module name="SuperFinalize"/&gt; &lt;module name="UnnecessaryParentheses"/&gt; &lt;!-- Checks for class design --&gt; &lt;!-- See http://checkstyle.sf.net/config_design.html --&gt; &lt;!-- 要求一个方法必须声明为Extension的,否则必声明为abstract, final or empty --&gt; &lt;!-- &lt;module name="DesignForExtension"/&gt; --&gt; &lt;!-- 检查private构造子是否声明为final,这里有个问题,在Java中构造子是不能声明为final的 --&gt; &lt;!-- &lt;module name="FinalClass"/&gt; --&gt; &lt;!-- 要求一定要有一个构造子 --&gt; &lt;!-- &lt;module name="HideUtilityClassConstructor"/&gt; --&gt; &lt;module name="InterfaceIsType"/&gt; &lt;!-- 检查变量的可见性,确省只允许static final 为public,否则只能为private --&gt; &lt;module name="VisibilityModifier"&gt; &lt;property name="packageAllowed" value="true"/&gt; &lt;property name="protectedAllowed" value="true"/&gt; &lt;/module&gt; &lt;!-- &lt;module name="MutableException"/&gt; --&gt; &lt;!-- 限制抛出声明的指定数量,确省为1 --&gt; &lt;!-- &lt;module name="ThrowsCount"/&gt; --&gt; &lt;!-- Miscellaneous other checks. --&gt; &lt;!-- See http://checkstyle.sf.net/config_misc.html --&gt; &lt;!-- 数组的声明是否允许Java的类型,确省为允许,Java类型为String[] xx,C++的类型为String xx[]; --&gt; &lt;module name="ArrayTypeStyle"/&gt; &lt;!-- &lt;module name="FinalParameters"/&gt; --&gt; &lt;!-- 一般性的代码问题,不好的习惯等,可以多 --&gt; &lt;!-- 文件中使用了System.out.print等--&gt; &lt;module name="GenericIllegalRegexp"&gt; &lt;property name="format" value="System/.out/.print"/&gt; &lt;property name="message" value="bad practice of use System.out.print"/&gt; &lt;/module&gt; &lt;module name="GenericIllegalRegexp"&gt; &lt;property name="format" value="System/.exit"/&gt; &lt;property name="message" value="bad practice of use System.exit"/&gt; &lt;/module&gt; &lt;module name="GenericIllegalRegexp"&gt; &lt;property name="format" value="printStackTrace"/&gt; &lt;property name="message" value="bad practice of use printStackTrace"/&gt; &lt;/module&gt; &lt;!-- 关于Task,你可以声明自己的Task标识 --&gt; &lt;module name="TodoComment"&gt; &lt;property name="format" value="TODO"/&gt; &lt;/module&gt; &lt;!-- 强迫//注释必须如何,入下要求只能有一行,具体看文档 --&gt; &lt;!-- &lt;module name="TrailingComment"&gt; &lt;property name="format" value="^//s*$"/&gt; &lt;/module&gt; --&gt; &lt;!-- main方法经常会在debug时使用,但发行版本的时候可能并不需要这个方法,提示 --&gt; &lt;!-- &lt;module name="UncommentedMain"/&gt; --&gt; &lt;!-- 当定义一个常量时,希望使用大写的L来代替小写的l,原因是小写的l和数字1很象 --&gt; &lt;module name="UpperEll"/&gt; &lt;!-- 检查正确的缩进,这个更象是个人习惯 --&gt; &lt;!-- &lt;module name="Indentation"&gt; &lt;property name="braceAdjustment" value="0"/&gt; &lt;/module&gt; --&gt; &lt;!-- Checks For Metrics --&gt; &lt;!-- See http://checkstyle.sf.net/config_metrics.html --&gt; &lt;!-- 检查嵌套复杂度 --&gt; &lt;module name="CyclomaticComplexity"&gt; &lt;property name="max" value="12"/&gt; &lt;/module&gt; &lt;/module&gt; &lt;/module&gt; </td> 
 </tr> 
 </tbody> 
</table>

# 五、Checkstyle常见的输出结果 #

**1．Type is missing a javadoc commentClass   **

缺少类型说明

**2．“\{” should be on the previous line**

“\{” 应该位于前一行

**3．Methods is missing a javadoc comment**

方法前面缺少javadoc注释

**4．Expected @throws tag for “Exception”**

在注释中希望有@throws的说明

**5．“.” Is preceeded with whitespace “.”**

前面不能有空格

**6．“.” Is followed by whitespace“.”**

后面不能有空格

**7．“=” is not preceeded with whitespace**

“=” 前面缺少空格

**8．“=” is not followed with whitespace   **

“=” 后面缺少空格

**9．“\}” should be on the same line    **

“\}” 应该与下条语句位于同一行

**10．Unused @param tag for “unused”**

没有参数“unused”，不需注释

**11．Variable “CA” missing javadoc**

变量“CA”缺少javadoc注释

**12．Line longer than 80characters   **

行长度超过80

**13．Line contains a tab character**

行含有”tab” 字符

**14．Redundant “Public” modifier**

冗余的“public” modifier

**15．Final modifier out of order with the JSL**

suggestionFinal modifier的顺序错误

**16．Avoid using the “.\*” form of import**

Import格式避免使用“.\*”

**17．Redundant import from the same package**

从同一个包中Import内容

**18．Unused import-java.util.list**

Import进来的java.util.list没有被使用

**19．Duplicate import to line 13**

重复Import同一个内容

**20．Import from illegal package**

从非法包中 Import内容

**21．“while” construct must use “\{\}”**

“while” 语句缺少“\{\}”

**22．Variable “sTest1” must be private and have accessor method**

变量“sTest1”应该是private的，并且有调用它的方法

**23．Variable “ABC” must match pattern “^\[a-z\]\[a-zA-Z0-9\]\*$”      **

变量“ABC”不符合命名规则“^\[a-z\]\[a-zA-Z0-9\]\*$”

**24．“(” is followed by whitespace    **

“(” 后面不能有空格

**25．“)” is proceeded by whitespace**

“)” 前面不能有空格

[o_e6_9c_aa_e5_91_bd_e5_90_8d-9.gif]: /images/20220331/2d8bc809d1af426da9de790e8d085d21.png
[o_e6_9c_aa_e5_91_bd_e5_90_8d-10.gif]: /images/20220331/9fb6dcea689d45adadd93f51d879b20a.png
[o_e6_9c_aa_e5_91_bd_e5_90_8d-8.gif]: /images/20220331/090386c54a8d46198765dc10003404f4.png
[o_e6_9c_aa_e5_91_bd_e5_90_8d-12.gif]: /images/20220331/4e3688351eac43dfb141b7448a9d9e3b.png
[o_e6_9c_aa_e5_91_bd_e5_90_8d-13.gif]: /images/20220331/df4cf99e29414136982360e139a842cc.png
[o_Image00001.gif]: /images/20220331/f5709ec7e3304dd89474f165f1b3cbf3.png
[o_e6_9c_aa_e5_91_bd_e5_90_8d-4.gif]: /images/20220331/ac527f8b28ba4d5dbc57b2fa1ba40078.png
[o_e6_9c_aa_e5_91_bd_e5_90_8d-5.gif]: /images/20220331/84b0395151914fc786058cd6e461ab78.png