1、简介
CheckStyle是SourceForge下的一个项目,提供了一个帮助JAVA开发人员遵守某些编码规范的工具。它能够自动化代码规范检查过程,从而使得开发人员从这项重要但枯燥的任务中解脱出来。它可以根据设置好的编码规则来检查代码。比如符合规范的变量命名,方法体的最大行数,重复代码检查等等。
如果你的项目经理开会时说:“我希望我们写出来的代码就象一个人写的!”,那么用Checkstyle绝对是正确选择!
2、安装
在线安装(注意在安装过程中保持网络畅通,如果网络不稳定可能会导致安装失败)
Help --> Install New Software
CheckStyle插件地址:http://eclipse-cs.sourceforge.net/update
Next-->next-->选择 I accept... Finish。Checkstyle插件就开始安装。
在安装过程中,可能会出现警告提示,选择ok即可。安装后重启。
3、使用
打开eclipse,Window-->Preferences,如果列表中出现了checkstyle的菜单,则表示安装成功了。
Window -->Preferences,选择checkstyle菜单,增加项目组统一的规则文件,并设置为默认规则。
到此全局配置已经完成。
4、Checkstyle项目配置
项目 --> 右键Properties
到此项目配置已经完成。成功的话,checkstyle已经开始工作了。
此次发现项目上有很多红叉叉,说明是代码符合规范造成的。
根据提示信息修改后,则没有有红色的提示。
5、其它操作
在项目右键菜单中,checkstyle还有一些快捷操作,如下图所示: