IntelliJ IDEA使用Alibaba Java Coding Guidelines编码规约扫描插件

news2024/9/29 21:31:38

代码规范和编码规约扫描插件使用

  • 为什么要有代码规范?
  • 1.代码规范插件
  • 2.idea插件安装
  • 3.插件使用介绍
    • 编码规约扫描使用
    • 编码规约扫描结果
  • 4.扫描结果严重级别
    • Blocker
    • Critical
    • Major
  • 5.《阿里巴巴Java开发手册(终极版)》

为什么要有代码规范?

个人理解:

项目的开发需要团队合作,就像篮球比赛需要五个人齐心合力才能赢得比赛一样。如果存在某个球员(程序员)过分的炫技,单打独斗,而毁掉整个团队的气氛,无论是比赛还是项目都不会能取得好的结果。简单来说,简洁易懂可读性高的程序可以提高代码维护的效率和成本,同时也可以很轻松的定位到bug的位置,提升可维护性和扩展性

关于此问题在我买的《阿里巴巴Java开发手册》的前言部分中,各位大佬给出了代码规范的见解

毕玄:一个优秀的工程师和一个普通的工程师的区别,不是满天飞的架构图,他的功底体现在所写的每一行代码上

多隆:工程师对于代码,一定要精益求精,不论从性能,还是简洁优雅,都要具备精益求精的工匠精神,认真打磨自己的作品

孤影:对程序员来说,关键是骨子里意识到规范也是生产力,个性化尽量表现在代码可维护性和算法效率的提升上

1.代码规范插件

Alibaba Java Coding Guidelines 是编码规约扫描插件,专注于Java代码规范,目的是让开发者更加方便、快速规范代码格式。该插件主要有以下特点

  1. 扫描代码后,将不符合规约的代码按 Blocker、Critical、Major 三个等级显示出来,并且给出编码修改建议
  2. 基于 Inspection 机制提供了实时检测功能,编写代码的同时也能快速发现问题所在

2.idea插件安装

首先ctrl+alt+s打开在Settings,然后找到Plugins搜索Alibaba Java Coding Guidelines最后点击lnstall,安装完成后重启idea生效
在这里插入图片描述

3.插件使用介绍

编码规约扫描使用

重启后会出现下图的图标,点击即可进行编码规约扫描(或者快捷键ctrl+alt+shift+j)
在这里插入图片描述

编码规约扫描结果

扫描完成后显示结果如下,扫描结果主要分为 Blocker、Critical、Major三个大类,它们表示的是问题的严重程度,严重程度由高到低为:Blocker(崩溃) > Critical(严重) > Major(一般)

在这里插入图片描述

4.扫描结果严重级别

Blocker

即系统无法执行、崩溃或严重资源不足、应用模块无法启动或异常退出、无法测试、造成系统不稳定。并且Blocker必须进行修改!!!

  • 严重花屏

  • 内存泄漏

  • 用户数据丢失或破坏

  • 系统崩溃/死机/冻结

  • 模块无法启动或异常退出

  • 严重的数值计算错误

  • 功能设计与需求严重不符

  • 其它导致无法测试的错误, 如服务器500错误

Critical

即影响系统功能或操作,主要功能存在严重缺陷,但不会影响到系统稳定性。

  • 功能未实现

  • 功能错误

  • 系统刷新错误

  • 数据通讯错误

  • 轻微的数值计算错误

  • 影响功能及界面的错误字或拼写错误

  • 安全性问题

Major

即界面、性能缺陷、兼容性。

  • 操作界面错误(包括数据窗口内列名定义、含义是否一致)

  • 边界条件下错误

  • 提示信息错误(包括未给出信息、信息提示错误等)

  • 长时间操作无进度提示

  • 系统未优化(性能问题)

  • 光标跳转设置不好,鼠标(光标)定位错误

  • 兼容性问题

5.《阿里巴巴Java开发手册(终极版)》

登录后可在线阅读或者下载,链接:https://developer.aliyun.com/ebook/386
在这里插入图片描述

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.coloradmin.cn/o/586005.html

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈,一经查实,立即删除!

相关文章

HTTPS协议深入理解

博主简介:想进大厂的打工人博主主页:xyk:所属专栏: JavaEE初阶 目录 文章目录 一、HTTPS协议的由来及概念 二、加密是什么 三、HTTPS的工作流程 3.1 使用对称密钥 3.2 引入非对称加密 3.3 中间人攻击 3.4 引入证书 一、HTTPS协议的由来及概念 HTTPS 也是…

【chatGPT4结对编程】chatGPT4教我做图像分类

开始接触深度学习 大语言模型火了之后,我也想过是否要加入深度学习的行业当中来,一开始的想法就是AI大模型肯定会被各大厂垄断,我们作为普通应用型软件工程师直接调用api就完事,另外对自己的学历也自卑(刚刚够线的二本&#xff0…

2.4. 封装与访问控制

封装(Encapsulation)是面向对象编程的一个核心概念,它意味着将数据(属性)和方法(操作数据的函数)捆绑在一起,形成一个类(Class)。封装的目的是将数据和操作数…

C++插件管理类(下)——实际项目(阉割版)

文章目录 一、背景二、代码结构三、两个CMakeLists.txt3.1 父目录3.2 子目录src 四、代码实例4.1 main.cpp4.2 Plugin.h4.3 Plugin.cpp4.4 Comm.h4.5 calc.cpp 五、 踩坑点 一、背景 请参考C插件管理类(上) 二、代码结构 三、两个CMakeLists.txt 3.1 父目录 #设置cmake的最…

stackqueue的模拟实现

stack模拟: stack的源代码: stack的全部源代码就这些。 stack的代码少,原因在于采用了适配器模式,所谓适配器,以电器为例,每个电器都有电源适配器,中国的家用电源为220V的交流电,但是…

3d虚拟主播形象能提升提升企业销售额

随着科技的不断进步和发展,虚拟人形象正在被广泛地应用于商业宣传中。3D虚拟人形象是指采用计算机图形学、人工智能等技术,模拟真实人类形象的虚拟形象。相比于传统产品营销方式,采用3D虚拟人形象进行产品交互讲解对提升企业销售额具有很多优…

JavaWeb12(实现基础分页模糊查询的分页)

目录 一. 效果预览 ​编辑 二. 实现基本分页 2.1 分页sql --每页3条 取第二页 --由于伪列不能作用与大于符号也不能作用于between....and --因此需要将伪列----->名列 2.2 万能公式 2.3 首页&上一页&下一页实现 ②前端代码 2.4 末页实现&优化 ①底层代…

目标检测复盘 -- 6. YOLOv4

Backbone YOLOv4的骨干是CSPDarknet53 CSP结构的作用:1. 增强CNN的学习能力 2. 移出计算瓶颈 3. 减少内存开销 CSP首先将输入的特征层分成两个部分,这里以densenet为例,part2分支经过denseblock后,进过一个transition&#xff0c…

Redis之高可用方案浅析

在工程项目中,系统应用的高可用性越来越重要,业主越来越重视。其实高可用可以分为应用层高可用和数据层高可用,数据层高可用中常见的有关系型数据库mysql的高可用、非关系型NoSQl数据库redis的高可用等,下面聊聊典型的NoSQL数据库…

C# 事件和委托的区别并说明

1.区别 事件是基于委托的,为委托提供了一个发布/订阅机制。可以说事件是一种特殊的委托,他的调用和委托是一样的。 事件的声明 public event 委托类型 事件名称 通常事件的命名以事件名称Event来命名。如public event delegate NotifyEvent; 事件和委…

C++ Primer Plus 第二章习题

目录 复习题 1.C程序的模块叫什么? 2.#include 预处理器编译指令的用处? 3.using namespace std; 该语句是干什么用的? 4.什么语句可以打印一个语句"hello,world",然后重新换行? 5.什么语句可以用来创…

桂院校园导航 导入 与 配置教程

将 静态项目/云开发项目 文件夹下最新版本的 文件夹下的 项目 的整个文件夹 复制到项目路径下(比如 D:\WeChatProjects),强烈建议不要直接扔在桌面上 云开发项目 需开通 云开发 功能(首月免费,次月19.9)&am…

【论文阅读笔记】CRFL: Certifiably Robust Federated Learning against Backdoor Attacks

个人阅读笔记,如有错误欢迎指出! 会议:PMLR 2021[2106.08283] CRFL: Certifiably Robust Federated Learning against Backdoor Attacks (arxiv.org) 问题: 现有的防御算法缺乏健壮性 创新: 证明了所提出框架得稳定性 通过马尔…

Generative AI 新世界 | 走进文生图(Text-to-Image)领域

在之前的四篇 “Generative AI 新世界” 中,我们带领大家一起探索了生成式 AI(Generative AI),以及大型语言模型(LLMs)的全新世界概览。并在文本生成(Text Generation)领域做了一些概…

javascript基础十:说说你对Javascript中this对象的理解

一、定义 函数的 this 关键字在 JavaScript 中的表现略有不同,此外,在严格模式和非严格模式之间也会有一些差别 在绝大多数情况下,函数的调用方式决定了 this 的值(运行时绑定) this 关键字是函数运行时自动生成的一…

进程控制与进程调度 —— 时间片轮转调度算法(C++版)

目录 实验一 进程控制与进程调度 一、实验目的 二、实验内容 三、数据结构及符号说明 四、运行环境说明 五、代码段 六、 效果展示 实验一 进程控制与进程调度 备注:大二(下)操作系统实验一 一、实验目的 掌握进程状态的转变、…

多次调用java.awt.Toolkit.getDefaultToolkit方法获得是同一个单例的Toolkit

多次调用java.awt.Toolkit.getDefaultToolkit方法获得是同一个单例的Toolkit java.awt.Toolkit.getDefaultToolkit()import java.awt.Toolkit;public class 多次调用Toolkit的getDefaultToolkit方法获得是同一个单例的Toolkit {static public void main (String...arguments)t…

WMS:系统窗口添加过程

WMS:系统窗口添加过程 1、经常使用的两大类窗口2、系统窗口StatusBar2.1 StatusBarWindowView添加流程2.2 简要时序图 android12-release 1、经常使用的两大类窗口 Android中的“窗口”类型有很多,经常使用的“窗口”大致分为两大类:一是,由系…

对于后端Linux的入门知识

为什么使用Linux 文章来自https://librehunt.org/,在这个网站里,你可以根据它提供的选项,最终选出适合你的Linux版本 It’s safe and private. No tracking. No company watching over you, no “big brother is watching you” nonsense. Ju…

article-三自由度机械臂运动学分析+仿真

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-rOmeEm3I-1685366971102)(data:image/svgxml;utf8, )] [外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-kCu0JrBB-1685366971103)(data:image/svgxml;utf8, )] 建立坐标系 1…