文章目录
1. 前言
- 1. 前言
- 2. 安装
- 3. 配置CheckStyle
- 3.1 新建CheckStyle代码规范文件
- 3.2 导入CheckStyle文件
- 4. 使用
CheckStyle
是SourceForge
下的一个项目,提供了一个帮助JAVA开发人员遵守某些编码规范的工具。它能够自动化代码规范检查过程,从而使得开发人员从这项重要,但是枯燥的任务中解脱出来。
CheckStyle检验的主要内容 :
·
Javadoc注释·
命名约定·
标题·
Import语句·
体积大小·
空白·
修饰符·
块·
代码问题- `·类设计
·
混合检查(包活一些有用的比如非必须的System.out和printstackTrace)
从上面可以看出,CheckStyle
提供了大部分功能都是对于代码规范的检查,而没有提供像PMD
和Jalopy
那么多的增强代码质量和修改代码的功能。但是,对于团队开发,尤其是强调代码规范的公司来说,它的功能已经足够强大。
首先打开IDEA菜单栏的Settings
中的plugins
,搜索CheckStyle-IDEA
并安装:
安装重启IDEA之后,Settings
下搜索Inspections
,再查询CheckStyle
,如果能查询到内容,说明安装成功:
首先在本地新建checkstyle.xml
文件,里面的内容如下:
3.2 导入CheckStyle文件
在Settings
中搜索CheckStyle
,按下图导入上一步骤新建的checkstyle.xml
文件: 勾选新增的配置文件,完成:
首先打开一个文件,右键选择 Check Current File
: 再控制台,可以看到该类有以下不规范的操作,双击提示,可以一步一步去解决规范的问题:
不一定每一次都打开文件,然后右键去运行查询脚本,其实可以直接打开要查询的文件,然后直接点击下图的启动图标即可:
如果想扫描整个包或整个项目,可以点击下图两个按钮,有提示:
本文完!