官网
CheckStyle官网:https://checkstyle.org/index.html
CheckStyle检查的是代码的格式、是否缺少文档,而非其中的缺陷.
插件安装
点击settings---->plugins---->Browse repositories
搜索框输入CheckStyle-IDEA并点击右侧Install按钮
安装完毕后重启idea
然后点击settings---->Editor---->Inspections查看一下CheckStyle是否安装成功
并且在ideal下方Tab页列表会出现CheckStyle的Tab页
下面我们选择一个默认的检查规范
然后点击settings---->Other Settings---->Checksytle,在Configuration File中选中Google Checks并保存
插件使用
在文件上右键选择Check Current File
检查结果显示在下发Tab页中
1:关闭当天Tab页
2:停止检查
3:检查当前文件
4:检查当前模块
5:检查整个项目
6:检查被改变的文件
7:检查变更列表文件
8:重新加载规则文件
9:跳转到Java代码
10:展开
11:收缩
12:展示错误级别的检查结果
13:展示警告级别的检查结果
14:展示提示级别的检查结果
15:选择不同的检查规范
使用自定义检查规范
我们很可能想使用自己公司定义的代码规范的checkstyle检测文件
在D盘根目录下创建一个规则配置文件MyCheckStyle.xml,文件内容如下
<?xml version="1.0"?>
<!DOCTYPE module PUBLIC
"-//Puppy Crawl//DTD Check Configuration 1.3//EN"
"http://www.puppycrawl.com/dtds/configuration_1_3.dtd">
<module name="Checker">
<!-- 文件长度不超过1500行 -->
<module name="FileLength">
<property name="max" value="1500"/>
</module>
</module>
然后将规则配置文件导入
然后点击settings---->Other Settings---->Checksytle,在Configuration File中add自定义的规则文件后保存
之后会在检查的时候就可以选择自己的规则校验文件了