本文中使用intelliJ IDEA版本为14.0.1,其他版本差异不大,可同样安装。

下载安装CheckStyle-IDEA插件

安装该插件有两种方式,在线安装和安装包安装

(1)    在线安装

File->Setting->Plugins至下图界面,搜索CheckStyle-IDEA,点击安装。

(2)安装包安装

解压附件中checkstyle-idea-4.10.0.zip,将CheckStyle-IDEA文件复制到IntelliJ IDEA 14.0.1安装目录下的plugins文件夹中。

   安装完成后,重启IntelliJ IDEA使插件生效。

配置checkstyle

File->Setting->Other Setting->checkStyle至下图界面

 

点击红框选中的绿色加号至上层页面添加自定义的检查规则,选择附件中的my_checks.xml,Next,Finish后至下图。

 

选中新添加的检查规则,并Apply即可。

 

使用checkStyle检查文件

在File->Setting->Editor->CheckStyle中选择是否进行实时检查。

 

(1)    实时检查,实时地对不规范的书写进行提示 ,并在编辑页面中进行颜色标识。

(2)    取消实时检查后,可在打开的文件中右击选择Check Current File对当前页面进行检查,此时可在下图所示的CheckStyle Scan 中查看不规范内容,点击条目可查看对应出错语句。

 

其他

如有一些必须的但不符合检查规则的地方需要忽略检查可以按照下述进行注释

// CSOFF: MagicNumber

 

需要忽略的代码段

 

// CSON: MagicNumber

其中MagicNumber为检查的一个步骤,表示检查魔法数,可以替换成其他的检查步骤,比如要忽略该段的行长度,可将MagicNumber改为LineLength即可。