什么是checkstyle
CheckStyle是SourceForge下的一个项目,提供了一个帮助JAVA开发人员遵守某些编码规范的工具。它能够自动化代码规范检查过程,从而使得开发人员从这项重要,但是枯燥的任务中解脱出来。
CheckStyle检验的主要内容
·Javadoc注释
·命名约定
·标题
·Import语句
·体积大小
·空白
·修饰符
·块
·代码问题
·类设计
·混合检查(包活一些有用的比如非必须的System.out和printstackTrace)
从上面可以看出,CheckStyle提供了大部分功能都是对于代码规范的检查,而没有提供象PMD和Jalopy那么多的增强代码质量和修改代码的功能。但是,对于团队开发,尤其是强调代码规范的公司来说,它的功能已经足够强大。
转自 http://www.oschina.net/p/checkstyle/
Eclipse插件安装
1. 明确需要安装的版本
不同的eclipse(MyEclipse是基于eclipse进行扩展的)能够安装的插件版本是不同,以下是checkstyle对eclipse不同版本的支持(checkstyle最新版为5.6 )
Checkstyle |
发布日期 |
Eclipse3.1 |
Eclipse3.2 |
Eclipse3.3 |
Eclipse3.4 |
Checkstyle 4.0.1 |
2005-12-15 |
OK |
OK |
OK |
OK |
Checkstyle 4.1.1 |
2006-08-13 |
OK |
OK |
OK |
OK |
Checkstyle 4.2.1 |
2007-01-07 |
OK |
OK |
OK |
OK |
Checkstyle 4.3.3 |
2007-10-30 |
OK |
OK |
OK |
OK |
Checkstyle 4.4.2 |
2008-06-25 |
× |
OK |
OK |
OK |
后续版本资料未找到 |
由于项目组统一使用MyEclipse6.5(eclipse3.2),所以使用4.4.2版本。由于updatesitehttp://eclipse-cs.sourceforge.net/update不能访问(5.6的updatesite http://sourceforge.net/projects/eclipse-cs/files/updatesite/5.6.0/ 可用),因此只能使用先下安装的方式:
(PS:如何获取插件的在线安装地址,首选的网上查找,当网上资料较少或不准确时,可以通过下载插件时附带的site.xml中获取,如下图
)
2. 安装
相对直接将features和plugins复制到eclipse安装目录下的“暴力”安装,个人更倾向link方式安装:
1) 将插件解压到到文件夹,格式需要满足:**/插件名称/eclipse/,如:
2) 在eclipse安装目录下找到link文件夹,插件名称.link文件(名称无强制,为了方便区分插件,以插件名称命名),内容如下:
path=D:/eclipse plugin/checkstyle
3) 重启eclipse,建议添加-clean重加载插件(eclipse.ini中通常已经使用该命令)
4 ) 观察Properties选项,观察存在CheckStyle目录,若存在,证明安装成功。
简单使用
开启eclipse/MyEclipse在需要进行验证的工程上点击右键-》Properties,在CheckStyle选项卡中勾选“Checkstyle active for this project”,等待工程编译完成。
来源:oschina
链接:https://my.oschina.net/u/614144/blog/123531