checkStyle使用详解

简介       

    checkStyle是一款代码格式检查工具，它根据设置好的编码规则来自动检查代码。比如命名规范，文件长度，代码行长度等等。代码检查工具是保证项目代码质量、统一编码风格的一种重要途径。本篇博客主要讲讲使用checkStyle的检查规则的陪置。

安装

    方法一：

1. 1. 1. Eclipse中，选择Help->Software Updates->Find and Install
      2. 选择 Search for new features to install 选择Next
      3. 选择 New Remote Site
      4. 输入更新地址:http://eclipse-cs.sourceforge.net/update
      5. 安装后重启即可

方法二：

1.下载eclipse插件:http://sourceforge.net/projects/eclipse-cs/

下载后，把里面的两个文件夹plugins和 features下面的文件分别拷贝到eclipse目录下面对应的plugins和features目录

2.如果你就这样直接启动eclipse 可能会出现ClassNotFoundExceptions 等错误，所以必须在启动eclipse的时候加上一个参数 -clean. 这样eclipse就可以更新它当前安装的许多插件信息

比如你得eclipse在d盘 那么就是 d:\eclipse\eclipse.exe -clean 

Checkstyle的陪置文件导入

    点击“Window”->“Preferences”菜单，在弹出窗口左侧点击“Checkstyle”，可看到右侧默认选中的是“Sun Checks”检查规则，因为该规则要求比较严格，而且不适合本研发中心，所以需要自定义检查文件。点击“New”按钮后，弹出“Check Configuration Properties”窗口，如下图所示：

    在上图中选择“Type”为“External Configuration File”（外部配置文件），在“Location”行点击“Browse”按钮浏览选择checkstyle的配置文件，例如eclipse_checkstyle.xml文件（仅供参考，可自行定义），并输入“Name”行的值，例如“eclipse_checkstyle”，点击“OK”按钮完成导入操作。回到Checkstyle主页面选择刚才添加的文件，点击“Set As Default”将其设置为默认checkstyle检查文件。

陪置详解

小结：这里也就是陪置文件中的陪置项需要有一点了解，些小的错误都会导致文件陪置文件无法导入成功。