Checkstyle使用参考.docx

1、Checkstyle使用参考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 添加新的变量值到

2、环境变量Path中 在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中用的属性文件，用户可以自定义下面的常用的属性# 项目名称proje

4、ct.name=TopShelf # 项目所在的路径project.dir=F:eclipseWorkSpace20061012WordEmTest # 源文件所在的路径project.src.dir=$project.dirsrc # 报告生成的位置, 默认的位置为$project.dirreport# 如果需要在其它位置生成报告, 请删除下面一行前面的#,并且在等号后面给出路径# project.checkstyle.report.dir=new path here # 检测结果文件名, 默认为$project.name-checkstyle-result-$DSTAMP.xml# 如果需

5、要在改成其它的文件名, 请删除下面一行前面的#,并且在等号后面给出新的文件名# 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 here 2.2 build.xml这个文件是运行Ant时需要用的文件 2.3 sunrising_checks.xml这个文件是Checkstyle在执行代码检测时需要用的配置文件，里面定义的检查规则。详细的规则定义将在第四节做详细介绍。 2.4 执行步骤A) 将上面提到的三个文件拷

7、贝到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和文件夹中的内容拷贝到Eclipse下对应的文件夹下C) 删除ECLIPSE_HOMEconfiguration下

8、的org.eclipse.update文件夹，然后重新启动Eclipse2 在Eclipse中使用CheckstyleA) 插件安装成功后，在Eclipse中点击Window-Preferences选项可以看到下图 B) 在项目上使用Checkstyle。右键单击项目，选择Properties选项后可以看到下图1) 选择Checkstyle2) 选中Check BoxCheckstyle active for this project3) 从下拉列表中选择一个Checkstyle的配置文件4) 点击OK 查看项目中的任意一个源文件，可以看到类似下图的情况：将鼠标指向图中的放大镜处稍做停留便可看到提示信息，如图片中的”Missing a Javadoc comment.” 四、Checkstyle配置文件的简要说明关于配置文件的各个模块的更多细节，请参考CHECKSTYLE_HOME/docs/index.html !DOCTYPE module PUBLIC -/Puppy Crawl/DTD Check Configuration 1.2/EN!-!-!-!-!-!-!-!-!-!-prope