软件开发事业部 编码改善文档
CheckStyle 使用说明
目的
本文是基于 eclipse Version: 3.1.0 和 checkstyle_4.0.0
概要
在目前的开发过程中,我们对编码的检查集中在项目即将结束时的“代码复
查”阶段。这个时候对代码进行复查,由于编码接近收尾,代码数量庞大,检查
任务繁重,根本不可能按照部门的编码标准来格式化代码。所以我们需要一个工
具来对代码进行检查。但是,即使是有了这样的工具,如果在“代码复查”阶段
才对代码格式进行检查。仍然难以达到要求的标准。所以我们希望将代码复查的
工作融合在编码过程中。这样一方面可以达到“代码复查”的目的;一方面有助
于提高程序员的编码质量意识,形成良好的编码习惯。Checkstyle 可以帮助我们
达到这个目标。
CheckStyle 使用说明
CheckStyle 的安装
下载地址:http://eclipse-cs.sourceforge.net/
CheckStyle 有两种使用方式,一种是通过 ant 来运行的方式;一种是利用插件
的使用方式。这里我们介绍插件的使用方式。
CheckStyle插件的安装很简单,将插件的文件夹复制到 eclipse 的 plugins 目录
下。启动 eclipse 即可。
CheckStyle 的配置说明
首先通过菜单 window—〉preferences 进入 CheckStyle 的配置项