IntelliJ IDEA checkstyle插件安裝与使用

发布于 2018-12-06 | 更新于 2020-09-20

IntelliJ IDEA 安装 checkstyle 插件

直接到插件管理界面搜索checkstyle插件进行安装即可。 问题:直接搜索安装,会一直提示找不到插件,可能 是天朝的网络问题,这里,我用最新(2018.11.30)的github插件代码编译了一个插件包提供给大家,在插件管理界面中点击Install plugin from disk...按钮,选择下载好的插件即可。 插件包:

链接: https://pan.baidu.com/s/1hRy3csIjXxbBuMmESPHfQg 提取码: ixfv

CheckStyle配置文件

为了让团队有一个统一的校验规范,我们需要制定一个 checkstyle.xml 文件,让所有开发同事都是用这个文件来校验,并且在提交代码审查做自动化构建测试的时候,是用这个文件来做校验,校验不通过,则直接审查不通过,避免不规范的代码入库,影响后续开发同事的工作。

注意:可以针对新项目开启自动化构建测试规范校验,老项目由于不规范的代码比较多,如果代码没有优化完成,则不建议开启自动化构建测试规范校验,会影响当前工作进度。如果老项目确定了要开启,请先使用checkstyle对老项目进行扫描,并且优化好所有的不规范的代码。

这里来有一个checktyle规则配置模板可以参考:符合阿里巴巴代码规范的checkstyle检测文件

代码检测

安装完成之后,打开ideaCheckStyle面板,进行代码检测即可,如下图: Rules中选择需要使用的CheckStyle配置文件,左边可以选择检测当前文件,当前模块,或者整个项目。记得把检测结果中的问题修复了,不然提交代码审查的时候,自动化构建测试是无法通过的。

本文作者: arthinking

本文链接: https://www.itzhai.comintellij-idea-checkstyle-install-and-usage.html

版权声明: 版权归作者所有,未经许可不得转载,侵权必究!联系作者请加公众号。

×
IT宅

关注公众号及时获取网站内容更新。