CheckStyle是SourceForge下的一个项目,提供了一个帮助JAVA开发人员遵守某些编码规范的工具。它能够自动化代码规范检查过程,从而使得开发人员从这项重要,但是枯燥的任务中解脱出来。
Eclipse安装checkstyle
打开eclipse-->Help-->Install New SoftWare...打出插件安装窗口
点击窗口中的“Add...”,弹出窗口,在窗口中输入以下信息。
Name:cs
Location:http://eclipse-cs.sf.net/update/
点击上图的OK之后,插件安装窗口就是显示以下内容,全部选择
然后一步一步点击“Next>” 就可以了。最后会提示你重新启动Eclipse,重启之后就完成了CheckStyle安装。
如何检查代码:
检查代码很简单,在某一个Eclipse中右击,选择Checkstyle,然后选择Check Code with Checkstyle 就可以完成此项目的代码检查。
代码检查完成之后可以通过查看CheckStyle violations与CheckStyle violations Charts 这两个View查看代码检查结果,也可以进入某一个类看检查结果。
CheckStyle violations 是一个Table类型的展示报表,可以点击某一个查看详情。
CheckStyle violations Charts 是一个饼图类型的展示报表,,可以点击某一个查看详情。
如何清除检查结果:
检查代码很简单,在某一个Eclipse中右击,选择Checkstyle,然后选择Clear CheckStyle violations 就可以清除检查结果,恢复代码清爽。
如果编辑检查点
在Eclipse中,选择菜单中选择Window-->Preferences-->checkstyle就可以打开Checkstyle设置页面。
请看上图,中间部分Table是检查定义,默认的有两个,一个是Google Checks ,一个是Sun Checks, 这两上是默认的检查定义,是不可以进行修改了,我们需要做的是按照其中一个新增一个进行修改。我就新创建了一个MyCheck,需要先导出再导入。
创建之后点击最右边的Configure...就可以打开设置页面了,如下图:
需要想修改哪一个,点击就可以修改相应的内容。。
以上是介绍了CheckStyle的简单安装及使用。详细有哪些检查点,请点击下面联接查看。