《checkstyle使用参考》由会员分享，可在线阅读，更多相关《checkstyle使用参考（26页珍藏版）》请在金锄头文库上搜索。
1、Checkstyle 使用参考一、Checkstyle 简介Checkstyle 是一个帮助开发者按照某种习惯编写 java 代码的工具，他实现了代码检查的自动化，帮助人们从这种繁琐的工作中解放出来。 默认提供了对 sun 编程规范的支持，但是 Checkstyle 是一个具有高可配置性的，你完全可以根据自己的要求来配置需要检查的内容。二、Checkstyle+Ant1 下载安装1.1 Ant 的下载安装下载 apache-ant-1.6.5-bin.zip，然后解压缩到 C:apache-ant-1.6.5（或其它路径下） 。添加新的环境变量 ANT_HOME添加新的变量值到环境变量 Pat
2、h 中在 Dos 窗口下输入 ant 回车，如果看到下图的内容，说明 Ant 已经成功安装了。 如果没看到上图的信息，请根据运行环境的实际情况检查下列信息ANT_HOME = C:apache-ant-1.6.5JAVA_HOME = C:j2sdk1.4.2_08Path = %ANT_HOME%bin;%JAVA_HOME%bin;(后面还有很多，这里就省略了)ClASSPATH = .;%JAVA_HOME%jrelibrt.jar;%JAVA_HOME%libtools.jar(注意上面一行等号后面是个点“.”后面接分号)1.2 Checkstyle 的下载安装下载 checkstyl
3、e-4.2.zip，然后解压缩到 C:checkstyle-4.2（或其它路径下） ，下文提到这个路径时将使用 CHECKSTYLE_HOME 代替。将 CHECKSTYLE_HOME 目录下的 checkstyle-optional-4.2.jar 拷贝到 ANT_HOMElib 目录下2使用 Ant 实现代码检查使用 Ant 实现代码检查，我们共需要三个文件 build.xml, user.properties 和sunrising_checks.xml，下面分别对讲解这三个文件。2.1 user.properties这个文件是将要在 build.xml 中用的属性文件，用户可以自定义下面
4、的常用的属性# 项目名称project.name=TopShelf# 项目所在的路径project.dir=F:eclipseWorkSpace20061012WordEmTest# 源文件所在的路径project.src.dir=$project.dirsrc# 报告生成的位置 , 默认的位置为$project.dirreport# 如果需要在其它位置生成报告, 请删除下面一行前面的#,并且在等号后面给出路径# project.checkstyle.report.dir=new path here# 检测结果文件名 , 默认为$project.name-checkstyle-result-$
5、DSTAMP.xml# 如果需要在改成其它的文件名, 请删除下面一行前面的#,并且在等号后面给出新的文件名# project.check.result.name=new name here# 检测报告文件名 , 默认为$project.name-checkstyle-report-$DSTAMP.html# 如果需要在改成其它的文件名, 请删除下面一行前面的#,并且在等号后面给出新的文件名# project.check.report.name=new name here# checkstyle 的配置文件 , 默认的配置文件为 $basedir/sunrising_checks.xml# 如果
6、需要使用其它的配置文件, 请删除下面一行前面的#,并且在等号后面给出配置文件的路径# checkstyle.config=new path here# checkstyle 的报告风格 , 默认值为 $basedir/contrib/checkstyle-noframes.xsl# checkstyle.report.style=new style here2.2 build.xml这个文件是运行 Ant 时需要用的文件 2.3 sunrising_checks.xml这个文件是 Checkstyle 在执行代码检测时需要用的配置文件，里面定义的检查规则。详细的规则定义将在第四节做详细介绍。2
7、.4 执行步骤A) 将上面提到的三个文件拷贝到 CHECKSTYLE_HOME 目录下B) 打开 DOS 窗口进入到 CHECKSTYLE_HOME 目录下C) 输入 ant，然后回车，如果能看到 BUILD SUCCESSFUL 就成功了。三、Checkstyle+Eclipse1 安装 Checkstyle 的 Eclipse 的插件A) 首选下载 Checkstyle 的 Eclipse 的插件com.atlassw.tools.eclipse.checkstyle_4.1.1-bin.zipB) 将插件解压缩后，将 features 和 plugins 和文件夹中的内容拷贝到 Ecli
8、pse 下对应的文件夹下C) 删除 ECLIPSE_HOMEconfiguration下的 org.eclipse.update 文件夹，然后重新启动Eclipse2 在 Eclipse 中使用 CheckstyleA) 插件安装成功后，在 Eclipse 中点击 Window-Preferences 选项可以看到下图 B) 在项目上使用 Checkstyle。右键单击项目，选择 Properties 选项后可以看到下图1) 选择 Checkstyle2) 选中 Check BoxCheckstyle active for this project3) 从下拉列表中选择一个 Checkstyl
9、e 的配置文件4) 点击 OK查看项目中的任意一个源文件，可以看到类似下图的情况：将鼠标指向图中的放大镜处稍做停留便可看到提示信息，如图片中的”Missing a Javadoc comment.”四、Checkstyle 配置文件的简要说明关于配置文件的各个模块的更多细节，请参考 CHECKSTYLE_HOME/docs/index.html 检查是否有构造子五、Checkstyle 常见的输出结果1 Type is missing a javadoc commentClass 缺少类型说明2 “” should be on the previous line“” 应该位于前一行3 Meth
10、ods 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
11、on the same line “” 应该与下条语句位于同一行10 Unused param tag for “unused”没有参数“unused” ，不需注释11 Variable “CA” missing javadoc变量“CA”缺少 javadoc 注释12 Line longer than 80characters 行长度超过 8013 Line contains a tab character行含有”tab” 字符14 Redundant “Public” modifier冗余的“public” modifier15 Final modifier out of order wi
12、th the JSLsuggestionFinal modifier 的顺序错误16 Avoid using the “.*” form of importImport 格式避免使用“.*”17 Redundant import from the same package从同一个包中 Import 内容18 Unused import-java.util.listImport 进来的 java.util.list 没有被使用19 Duplicate import to line 13重复 Import 同一个内容20 Import from illegal package从非法包中 Impor
13、t 内容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-za-zA-Z0-9*$” 变量“ABC ”不符合命名规则“a-za-zA-Z0-9*$”24 “(” is followed by whitespace “(” 后面不能有空格25 “)” is proceeded by whitespace“)” 前面不能有空格本文来自 CSDN 博客，转载请标明出处：http:/
