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

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


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

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

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

1.导入CheckStyle插件

1.File ——> setting 安装插件

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

2.配置插件

3.开始C

选择你需要checkstyle的类右击:

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

或者:

基于 Spring Boot + MyBatis Plus + Vue & Element 实现的后台管理系统 + 用户小程序,支持 RBAC 动态权限、多租户、数据权限、工作流、三方登录、支付、短信、商城等功能

2.报错原因和处理方式

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

1.第一大类:注解问题

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

注解不全,补齐就行

image.png

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

image.png

2.字符占位问题

先按自己的需求设置code style

然后右击选择

即可解决

tab问题的话

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

基于 Spring Cloud Alibaba + Gateway + Nacos + RocketMQ + Vue & Element 实现的后台管理系统 + 用户小程序,支持 RBAC 动态权限、多租户、数据权限、工作流、三方登录、支付、短信、商城等功能

3.见名知意

按要求改就ok了

删掉就行

4.格式问题

名字问题

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

5.逻辑错误

6.导包顺序

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



相关文章
|
存储 Java Apache
Maven - 统一构建规范:Maven 插件管理最佳实践
Maven - 统一构建规范:Maven 插件管理最佳实践
1063 0
|
JavaScript Java Maven
|
Java Apache Maven
使用checkstyle来规范你的项目
Checkstyle是什么 自从做了程序员,关于格式化的讨论就不曾中断过,到底什么才是正确的,什么才是错误的,到现在也没有完整的定论。但随着时间发展,渐渐衍生出一套规范出来。没有什么绝对的正确和错误,关键在于规范的定义。
5662 0
|
1月前
|
IDE Java 持续交付
提升代码质量:CheckStyle插件的实践与心得
在软件开发过程中,代码的规范性是保证项目质量和维护性的重要因素。然而,手动检查代码规范既耗时又容易出错。为了解决这一问题,许多开发团队引入了自动化工具来帮助维护代码规范。CheckStyle就是这样一款广受欢迎的代码质量检查工具。本文将分享CheckStyle插件的实践应用和使用心得,探讨它是如何帮助我们提升代码规范性的。
34 0
|
2月前
|
人工智能 Java 数据库连接
IDEA开发 常用代码规范插件 常用辅助类插件
IDEA开发 常用代码规范插件 常用辅助类插件
76 0
|
7月前
|
Java 测试技术 Maven
单元测试添加运行参数的maven插件
单元测试添加运行参数的maven插件
64 0
|
NoSQL Java Maven
【巧立名目】利用IDEA工具修改Maven多模块项目标识包名全过程
【巧立名目】利用IDEA工具修改Maven多模块项目标识包名全过程
1391 0
【巧立名目】利用IDEA工具修改Maven多模块项目标识包名全过程
|
Java Android开发 开发者
第五章 Gradle插件
说起Gradle的插件,不得不感叹Gradle的设计。Gradle的设计非常好,它本身提供一些基本的概念和整体核心的框架,其他用于描述真实的使用场景逻辑都以插件扩展的方式来实现,这样Gradle的设计者就可以抽象的方式提供一个核心的框架,其他具体的功能和业务等都通过插件扩展的方式来实现,比如构建Java应用,就是通过Java插件来实现的。
323 0
第五章 Gradle插件
|
XML IDE Java
【Groovy】Gradle 构建工具 ( 自动下载并配置构建环境 | 提供 API 扩展与开发工具集成 | 内置 Maven 和 Ivy 依赖管理 | 使用 Groovy 编写构建脚本 )
【Groovy】Gradle 构建工具 ( 自动下载并配置构建环境 | 提供 API 扩展与开发工具集成 | 内置 Maven 和 Ivy 依赖管理 | 使用 Groovy 编写构建脚本 )
295 0
【Groovy】Gradle 构建工具 ( 自动下载并配置构建环境 | 提供 API 扩展与开发工具集成 | 内置 Maven 和 Ivy 依赖管理 | 使用 Groovy 编写构建脚本 )
|
XML Java Maven
【Groovy】构建工具 ( 构建工具引入 | Gradle 构建工具作用 | 传统的依赖管理 )
【Groovy】构建工具 ( 构建工具引入 | Gradle 构建工具作用 | 传统的依赖管理 )
156 0

热门文章

最新文章