IDEA使用CheckStyle代码规范

IDEA使用CheckStyle代码规范说明

前言:

CheckStyle是SourceForge下的一个项目,提供了一个帮助JAVA开发人员遵守某些编码规范的工具。它能够自动化代码规范检查过程,从而使得开发人员从这项重要,但是枯燥的任务中解脱出来。

CheckStyle检验的主要内容

·Javadoc注释

·命名约定

·标题

·Import语句

·体积大小

·空白

·修饰符

·块

·代码问题

·类设计

·混合检查(包括一些有用的比如非必须的System.out和printstackTrace)

从上面可以看出,CheckStyle提供了大部分功能都是对于代码规范的检查,而没有提供像PMD和Jalopy那么多的增强代码质量和修改代码的功能。但是,对于团队开发,尤其是强调代码规范的公司来说,它的功能已经足够强大。

第一步 下载CheckStyle-IDEA插件

点击Browse repositories–>再搜索CheckStyle–>找到CheckStyle-IDEA–>再点击Install–>自动安装完成后重启
IDEA使用CheckStyle代码规范_第1张图片第二步 导入规则文件

找到Other Settings –>点击Checkstyle–>再点击Configuration File的加号

先填写规则描述名–>然后点击Browse导入规则文件–>点击Next–再点击Finish
IDEA使用CheckStyle代码规范_第2张图片

(或者是自带的谷歌和sun的规范)

IDEA使用CheckStyle代码规范_第3张图片

第三步 使用

点击状态栏上的CheckStyle按钮,点击(红叉按钮下)旁边的Check project 或者check Module按钮,检查工程的不规则编码和习惯

IDEA使用CheckStyle代码规范_第4张图片

双击不规范列表的一条数据,直接进入界面修改不规范代码

IDEA使用CheckStyle代码规范_第5张图片

如果需要界面不报异常红,勾选Treat Checkstyle errors as warnings,最后重启工程或AS

IDEA使用CheckStyle代码规范_第6张图片

备注一:

Check.xml

代码示例









 



​    

​	 

​		

​    



 

备注二

下载相关文件 https://github.com/checkstyle/checkstyle/releases/

xml https://checkstyle.sourceforge.io/

备注三

在源代码中可以使用快捷键将代码依照Google Java Style Guide进行格式化:

Ctrl + Alt + L 格式化代码

Ctrl + Alt + I 自动缩进

Ctrl + Alt + O 整理import

你可能感兴趣的:(Java进修之道)