CheckStyle、FindBugs和PMD的安装与使用教材.docxVIP

CheckStyle 、FindBugs和PMD 三个插件的安装 方法一： Eclipse中，选择Help-Install New Software 2.点击Add来新增一个安装 ? 3.输入安装名称和地址 CheckStyle： /projects/eclipsecs/files/updatesite/5.6.0/ Findbugs： /eclipse PMD：/projects/pmd/files/pmdeclipse/update-site-latest/ 如果安装地址不对，会报错，如下图： 如果安装地址正确，如下： 4. 安装后重启即可 ? 5.安装好之后,右击项目选择属性，可以看到安装是否成功 方法二： 1.下载eclipse插件 下载后，把里面的两个文件夹plugins和 features下面的文件分别拷贝到eclipse目录下面对应的plugins和features目录 2.如果你就这样直接启动eclipse 可能会出现ClassNotFoundExceptions 等错误，所以必须在启动eclipse的时候加上一个参数 -clean. 这样eclipse就可以更新它当前安装的许多插件信息 比如你得eclipse在d盘 那么就是 d:\eclipse\eclipse.exe -clean CheckStyle的介绍和使用 介绍 Checkstyle是一款检查java程序代码样式的工具，可以有效的帮助我们检视代码以便更好的遵循代码编写标准，特别适用于小组开发时彼此间的样式规范和统一。Checkstyle提供了高可配置性，以便适用于各种代码规范，所以除了可以使用它提供的sun的代码标准外，你也可以定制自己的标准。我们可以在eclipse中安装checkstyle的插件，来方便我们的使用。 Checkstyle可以让我们养成书写良好代码风格的习惯，代码的整洁也减少了很多bad smell的产生。使用checkstyle的过程中可能需要经常的调整配置文件，有些check过于严格，可以根据实际情况取消一些代码检查。 使用 2.1 CheckStyle使用样例 I．配置好项目的checkstyle属性 .右击项目，点击Checkstyle中的Check code with Checkstyle 选择某个项目，点击右键选择“Checkstyle”，会出现如下菜单： Configure project(s) from blueprint：指定工程加入Checkstyle检查； Activate Checkstyle：激活Checkstyle； Deactivate Checkstyle：取消激活Checkstyle； Check code with Checkstyle：使用Checkstyle检查代码； Clear Checkstyle violations：去掉Checkstyle的检查提示。 Create Formatter-Profile：创建格式化文件。 .运行结果 选择“Check code with Checkstyle”对所选中的项目进行检查，检查后对有问题的类会使用警告或错误标识。参考提示信息如下：???????? ?????????左侧会显示小圆圈，将鼠标移动到上面时将给出提示信息。 ??使用Checkstyle后，注释、变量命名规范性、类中变量、构造函数、方法的顺序的检查、行的长度、文件的长度、方法的长度等都不需要手工进行检查，只需要在代码评审时使用Checkstyle检查即可。因此，让代码评审人员将侧重点放在Checkstyle检查不出来的一些代码的优化问题。 . 自己添加规则 新建一个文本文档，保存为xml格式，写入如下内容： 在项目的Checkstyle属性里，添加自己的规则： 选择使用自己的规则： 选中自己的规则： 重新运行Check code with Checkstyle： 可以看到，当我定义规则if层次最大为3时，如果代码的if层次超过了3，则会提示错误。 .Checkstyle violations chart视图 点击Windows的Perferences下的other项，选中Checkstyle中的Checkstyle violations chart： 选择Checksty violations chart视图,会把每种不规范的信息做下统计，绘制成图表： 2.2 CheckStyle常见错误提醒 错误提示错误说明missing a javadoc comment缺少类注释Line longer than X characters行长度超过X个字符(包括空格)Return count is X(max allowed 3)一个方法内的返回数量是X(最大值只能