Checkstyle 安装与基本使用方法

Checkstyle是一款代码规范检查工具，一般是作为Eclipse的插件使用。这里简要介绍checkstyle的安装与基本使用。

1. 安装

下载插件解压后放于eclipse的dropins文件夹下（此方法适用于eclipse较高版本，可能是3.5以上），或使用link方式，即建立文件夹D:\eclipse plugin\checkstyle\eclipse，将解压后的插件放于eclipse文件夹中，在eclipse的目录中找到links文件夹，新建一个checkstyle.link文件，内容为path=D:/eclipse plugin/checkstyle，然后重启eclipse即可安装完成。注意link方式适用与eclipse较低版本。同时，eclipse与checkstyle版本的兼容也需注意，否则安装后不会显示插件，一般eclipse3.4以下版本用checkstyle4.2可以正常使用，eclipse4以上版本可以适用checkstyle较高版本，目前为5.6。

1. 设置

Eclipse中Window→Preferances，按如下图进行设置：

                                          

                                                                                                             图1

这里如果想导入自己制定的规则，可点击【new】新建一个检查配置，选择，选择导入文件，即可。

如果想直接在此制定规则，则可点击【new】，选择，确定后，在图一中会看见此配置，选择该条配置，点击【Configuer】，出现图2所示页面。

                                                 

                                                                                                           图2

左侧表示可以选择的规则，点击【add】，进行参数设置，便可设置成功。这里可选择多个，完成后点击【OK】，完成设置。

1. 使用

这里给出一段小程序作为例子。我们事先进行检查配置，命名为demo，所配置的项分别为：(1)LineLength：每行代码长度，为展示效果，这里设置为最大值60；

(2)JavadocMethod: 检查所有方法的Javadoc注释；

(3)Whitespace around：逻辑符号前后需要有空格；

(4)NeedBrace: if else 仅有一条语句也需使用{ }括上；

(5)Emptystatement：检查空语句。

选中工程，右键选择Properties，选择CheckStyle，按图3进行设置：      

                                                         

                                                                                                                图3

设置后选择已经编写好的java程序，右键选择CheckStyle→Check Code with CheckStyle，则程序会显示如下效果：

                                                                   图5

根据提示修改即可，如第4行为方法缺少javadoc，第5行为乘号前后无空格，第9行存在空语句，第14行行长度超过最大值。