首页
学习
活动
专区
圈层
工具
发布
社区首页 >专栏 >自从用了CheckStyle插件,代码写的越来越规范了....

自从用了CheckStyle插件,代码写的越来越规范了....

原创
作者头像
程序员皮皮林
发布2025-07-11 22:58:28
发布2025-07-11 22:58:28
4110
举报
  • 1.导入CheckStyle插件
  • 2.报错原因和处理方式
  • 3.见名知意
  • 4.格式问题
  • 5.逻辑错误
  • 6.导包顺序

CheckStyle作为检验代码规范的插件,除了可以使用配置默认给定的开发规范,如Sun的,Google的开发规范啊,也可以导入像阿里的开发规范的插件。事实上,每一个公司都存在不同的开发规范要求,所以大部分公司会给定自己的check规范,一般导入给定的checkstyle.xml文件即可实现。

作为新人,我checkstyle了一整个项目,苦不堪言,所以大家怕是还是多注意代码规范啊,利人利己。

楼主用的是idea,所以先说一下插件的导入,然后再细说怎么修改不规范的代码。

1.导入CheckStyle插件

1.File ——> setting 安装插件
图片
图片

图片

图片
图片

图片

也可以下载阿里的开发规范,看个人需求和喜好。

图片
图片

图片

2.配置插件
图片
图片

图片

图片
图片

图片

图片
图片

图片

3.开始

选择你需要checkstyle的类右击:

图片
图片

图片

点击checkstyle,因为我导入的是阿里巴巴,使用checkstyle的按键被占用了,懒得弄了,阿里蛮好的

或者:

图片
图片

图片

2.报错原因和处理方式

原则:少改动代码,处理时候不盲目大意,git提交多写点改动的情况。

1.第一大类:注解问题

缺少注解,点击问题即可跳转到缺少注解的地方

图片
图片

图片

注解不全,补齐就行

图片
图片

图片

补齐,每一个@的值都要完整

图片
图片

图片

2.字符占位问题
图片
图片

图片

先按自己的需求设置code style

图片
图片

图片

然后右击选择

图片
图片

图片

即可解决

tab问题的话

图片
图片

图片

默认情况下的是tab=4个空格,不存在tab的情况的,其实我也不会,欢迎补充。

3.见名知意

图片
图片

图片

按要求改就ok了

图片
图片

图片

删掉就行

4.格式问题

名字问题

图片
图片

图片

建议少改动,如果是公共类,影响较大,还是提前多留意吧。

5.逻辑错误

图片
图片

图片

图片
图片

图片

6.导包顺序

图片
图片

图片

类似这种情况的,都是导包顺序没有按照checkstyle的规范,一般情况下,eclispe的ctrl + shift + o 快捷键可以解决这个盗版问题,idea的也一样,当然也可以右击选择

图片
图片

图片

原创声明:本文系作者授权腾讯云开发者社区发表,未经许可,不得转载。

如有侵权,请联系 cloudcommunity@tencent.com 删除。

原创声明:本文系作者授权腾讯云开发者社区发表,未经许可,不得转载。

如有侵权,请联系 cloudcommunity@tencent.com 删除。

评论
登录后参与评论
0 条评论
热度
最新
推荐阅读
目录
  • 1.导入CheckStyle插件
    • 1.File ——> setting 安装插件
    • 2.配置插件
    • 3.开始
  • 2.报错原因和处理方式
    • 1.第一大类:注解问题
    • 2.字符占位问题
  • 3.见名知意
  • 4.格式问题
  • 5.逻辑错误
  • 6.导包顺序
领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档