Checkstyle使用参考.docVIP

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 添加新的变量值到环境变量Path中 在Dos窗口下输入ant回车，如果看到下图的内容，说明Ant已经成功安装了。 如果没看到上图的信息，请根据运行环境的实际情况检查下列信息 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, perties和sunrising_checks.xml，下面分别对讲解这三个文件。 2.1 perties 这个文件是将要在build.xml中用的属性文件，用户可以自定义下面的常用的属性 # 项目名称 =TopShelf # 项目所在的路径 project.dir=F\:\\eclipse\\WorkSpac\WordEmTest # 源文件所在的路径 project.src.dir=${project.dir}\\src # 报告生成的位置, 默认的位置为${project.dir}\\report # 如果需要在其它位置生成报告, 请删除下面一行前面的#,并且在等号后面给出路径 # project.checkstyle.report.dir=new path here # 检测结果文件名, 默认为${}-checkstyle-result-${DSTAMP}.xml # 如果需要在改成其它的文件名, 请删除下面一行前面的#,并且在等号后面给出新的文件名 # =new name here # 检测报告文件名, 默认为${}-checkstyle-report-${DSTAMP}.html # 如果需要在改成其它的文件名, 请删除下面一行前面的#,并且在等号后面给出新的文件名 # =new name here # checkstyle的配置文件, 默认的配置文件为${basedir}/sunrising_checks.xml # 如果需要使用其它的配置文件, 请删除下面一行前面的#,并且在等号后面给出配置文件的路径 # checkstyle.config=new path here # checkstyle的报告风格, 默认值为${basedir}/contrib/checkstyle-noframes.xsl # checkstyle.report.style=new style here 2.2 build.xml 这个文件是运行Ant时需要用的文件 project name=checkstyle default=checkstyle basedir=. 　　!-- 导入属性文件 -- property file=perties / target name=init tstamp/ !-- 报告的生成位置 -- property name=project.checkstyle.report.dir value=${project.dir}/report/ !-- 检测结果的文件名 -- property name= value=${}-checkstyle-result-${DSTAMP}