Ant + checkstyle 实现代码检查
1 checkstyle简介
checkstyle是一个帮助开发者按照某种习惯编写java代码的工具,他实现了代码检查的自动化,帮助人们从这种繁琐的工作中解放出来。
默认提供了对sun编程规范的支持,但是checkstyle是一个具有高可配置性的,你完全可以根据自己的要求来配置需要检查的内容。
2 工具下载、安装
2.1 Ant下载
最新版本1.6.1,下载地址:
解压缩到c:/ant1.6.1,后面将引用为%ant_home%
2.2 cheskstyle下载
最新版本3.3,下载地址:
解压缩到c:/checkstyle3.3,后面将引用为%checkstyle_home%
3 简单配置
3.1 环境变量:
set path=%ant_home%/bin
set classpath=%checkstyle_home%/checkstyle-all-3.3.jar
3.2 build.xml文件
n 增加taskdef
classpath="%checkstyle_home%\checkstyle-all-3.3.jar"/>
n 增加task
属性说明:
config 要使用的格式配置文件
classpath 要用到的jar文件
fileset 需要检查的文件集合
4 说明
需要检查的内容是基于module配置的,所以如果你不要检查那些module,你可以将他去掉,下面是默认的sun代码规范检查的配置文件:
"-//Puppy Crawl//DTD Check Configuration 1.1//EN"
"">
5 如何自己配置
可以看到,xml里面的内容都是类似这样的,这表示检查这部分的规范,置于具体的规范内容,每个module的前面都有连接地址,大家可以去看。
以为例:
他的要求是说,每个包下面都要有个package.html文件,如果你不想检查这一项,你可以将这个元素从xml内容中删除。
阅读(2586) | 评论(0) | 转发(0) |