什么是checkStyle


CheckStyle是SourceForge下的一个项目,提供了一个帮助JAVA开发人员遵守某些编码规范的工具。它能够自动化代码规范检查过程,从而使得开发人员从这项重要,但是枯燥的任务中解脱出来。



CheckStyle检验的主要内容



·Javadoc注释



·命名约定



·标题



·Import语句



·体积大小



·空白



·修饰符



·块



·代码问题



·类设计



·混合检查(包括一些有用的比如非必须的System.out和printstackTrace)



从上面可以看出,CheckStyle提供了大部分功能都是对于代码规范的检查,而没有提供象PMD和Jalopy那么多的增强代码质量和修改代码的功能。但是,对于团队开发,尤其是强调代码规范的公司来说,它的功能已经足够强大。






为什么使用checkStyle


写出简洁,易读的代码是一个高级程序员必备的技能,也更利于团队之间的合作。有些公司可能会有自己公司的代码规范,比较出名的就有华为java规范。如果你没有时间很好的去熟记这些规范,那checkStyle可以帮助我们自动检测到哪些不符合规范。减少写出垃圾代码的几率。








Myeclipse安装checkstyle插件

下载


首先下载Eclipse checkStyle PLUG-IN(官方地址: http://sourceforge.net/projects/eclipse-cs/files/ )








安装


打开Myeclipse  选择help-》Myeclipse configuration center如下图


myeclipse安装checkstyle插件_myeclipse




点击software栏目 add site 进行添加,这里我们选择进行本地添加


myeclipse安装checkstyle插件_eclipse_02




myeclipse安装checkstyle插件_eclipse_03




选择我们下载的压缩包文件 


myeclipse安装checkstyle插件_eclipse_04




Name可以随便起




myeclipse安装checkstyle插件_myeclipse_05




安装完成后,checkStyle插件已经出现




myeclipse安装checkstyle插件_myeclipse_06








启用checkStyle
Personal Sites栏里选择Eclipse Checkstyle Plug-in,然后右键选择Add to Profile…,Software Updates Available栏里面打上勾,在底下的Pending Changes栏里点击Apply 1 Change按钮。


myeclipse安装checkstyle插件_checkStyle_07




myeclipse安装checkstyle插件_myeclipse_08




然后按照提示安装启动 




这一步安装插件可能出现"Resolving and validating the profile"卡死不动的问题,其实只要断网就可以继续了。


myeclipse安装checkstyle插件_代码规范_09



I acknowledge and accept ALL of the above licenses打勾,点击Next。


myeclipse安装checkstyle插件_代码规范_10


剩余空间确认,点击Update。 


myeclipse安装checkstyle插件_eclipse_11




耐心等待安装结束…


然后重启即可


myeclipse安装checkstyle插件_代码规范_12




启动完成后要生效必须要重启一下myeclipse












配置


经过上面的步骤,checkStyle已经可以使用了。现在我们进行配置,配置使用哪一种checkStyle.xml以及哪个项目使用。


重启myeclipse之后,window-》preference之后如下图


安装好的checkStyle默认已经有3种检查的规范了,如果我们有公司自己的规范,可以点击new进行添加


myeclipse安装checkstyle插件_myeclipse_13








myeclipse安装checkstyle插件_myeclipse_14




location选择 我们的规范.xml




myeclipse安装checkstyle插件_myeclipse_15




点击set as default


这样已有的项目都会采用这个检查标准


myeclipse安装checkstyle插件_checkStyle_16














如果要单独修改某个项目的检查方案,在你要检查的项目中右键-属性 如下图:


myeclipse安装checkstyle插件_myeclipse_17