在eclipse中使用checkstyle插件自动检查编码规范

 

 

 

 

 

CheckStyle是一个java代码规范检查工具。使用CheckStyle能够强制编程人员遵循某种代码规范。CheckStyle默认提供了对sun编程规范的支持。通过编写配置文件，可以增加自己的检查规范。

CheckStyle的最新版本是3.5。从3.0开始，CheckStyle支持包括代码风格、代码结构、代码冗余、典型错误等更多的代码检查。

CheckStyle通常和Ant配合使用。有许多CheckStyle的第三方插件，包括eclipse插件。

CheckStyle的官方网站：http://checkstyle.sourceforge.net/

CheckStyle默认支持的sun规范见：http://java.sun.com/docs/codeconv/html/CodeConvTOC.doc.html，这个文档有中文翻译。

CheckStyle的下载地址：http://sourceforge.net/project/showfiles.php?group_id=29721

CheckStyle的eclipse插件下载地址：http://prdownloads.sourceforge.net/eclipse-cs/com.atlassw.tools.eclipse.checkstyle_3.3.2.0.zip?download

 

 

 

 

 

在eclipse环境下安装CheckStyle插件后，启动ecslipse，在首选项中可以导入和配置CheckStyle的配置文件。CheckStyle默认安装了sun的java代码规范。

       不符合checkstyle检查标准的信息“即时”出现在“问题”视图中。

   

       可以点击问题视图的“过滤器”配置显示内容。

   

       CheckStyle的检查规则包含在XML格式的配置文件里。CheckStyle默认的sun规范检查文件是：sun_checks.xml。

       CheckStyle的配置文件由module组成。Module的结构是树。树的root module是Checker。

作者简介：张昱，可以通过e-zhangyu@vip.sina.com 与作者取得联系。