2008-06-24
代码格式检查工具Checksytle的配置
Checksytle 是一款代码格式检查工具。它可以根据设置好的编码规则来检查代码。 比如符合规范的变量命名,良好的程序风格等等。其是目前最广泛使用的代码检查工具,功能强大,操作简单可以和Ant结合使用,也可以作为eclipse的插件,最重要的是其是Open Source的,你不用担心侵权,o(∩_∩)o…!
本文仅对Checksytle和Ant结合使用进行简要的阐述,其作为eclipse的插件的使用及其配置属性的详细内容,请参照附件或在网上收集资料。
1.下载:
Checksytle的文件包在这 (目前最新版是4.4)请到网上自行下载
http://downloads.sourceforge.net/checkstyle/checkstyle-4.1.zip
2.安装配置:
在Jbatch工程下按照下面目录建立文件。
Jbatch\check
│─build_codecheck.xml ant下checkstyle的启动文件
│
└─checkstyle
│─checkstyle.xml checkstyle需要检查的属性文件
│
└─lib
│─checkstyle-all-4.1.jar Checkstyle ライブラリ
│─checkstyle-optional-4.1.jar
其中checkstyle-all-4.1.jar和checkstyle-optional-4.1.jar这两个文件在下载好的checkstyle-4.1.zip下,将checkstyle-4.1.zip中的这两个文件拷贝到lib目录下,这两个文件是checkstyle运行的主要库文件。
build_codecheck.xml是ant下启动checkstyle的配置文件。可参照附件中的文件进行配置。
checkstyle.xml是我们对代码进行规则检查的具体配置文件,Checkstyle的配置性极强,你可以只检查一种规则,也可以检查三十,四十种规则。可以使用Checkstyle自带的规则, 也可以自己增加检查规则。(这点跟ant自定义target比较象),具体请参照附件中MARCHE中的规则。
在工程的build文件中加入以下代码(调用启动文件build_codecheck.xml):
<target name="codecheck" depends="compile">
<ant antfile="check/build_codecheck.xml" target="codecheck" inheritAll="false" />
</target>
3.运行:
完成上面的步骤,基本上已经大功告成,只差部署运行了。执行build.xml后会发现操作选项多了一个codecheck选项,在编译选项(build或dist)后讲其选中,执行。这时你再到check文件夹下,你会发现文件夹下多了一个文件夹result,其下多了一个check_result.xml,大功告成Jo(∩_∩)o…,这就是我们要得到的结果。需要强调的是,Checkstyle只能做检查,而不能做修改代码。
大家自己动手操作一番后,理解得会更加透彻,也希望各位在今后的工作中将这个工具运用的更加熟练。谢谢o(∩_∩)o…!!


评论