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

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

  • 为什么要有代码规范?
  • 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生效
IntelliJ IDEA使用Alibaba Java Coding Guidelines编码规约扫描插件_第1张图片

3.插件使用介绍

编码规约扫描使用

重启后会出现下图的图标,点击即可进行编码规约扫描(或者快捷键ctrl+alt+shift+j)
IntelliJ IDEA使用Alibaba Java Coding Guidelines编码规约扫描插件_第2张图片

编码规约扫描结果

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

IntelliJ IDEA使用Alibaba Java Coding Guidelines编码规约扫描插件_第3张图片

4.扫描结果严重级别

Blocker

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

  • 严重花屏

  • 内存泄漏

  • 用户数据丢失或破坏

  • 系统崩溃/死机/冻结

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

  • 严重的数值计算错误

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

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

Critical

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

  • 功能未实现

  • 功能错误

  • 系统刷新错误

  • 数据通讯错误

  • 轻微的数值计算错误

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

  • 安全性问题

Major

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

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

  • 边界条件下错误

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

  • 长时间操作无进度提示

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

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

  • 兼容性问题

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

登录后可在线阅读或者下载,链接:https://developer.aliyun.com/ebook/386
IntelliJ IDEA使用Alibaba Java Coding Guidelines编码规约扫描插件_第4张图片

你可能感兴趣的:(#,IDEA,Java,java,intellij-idea,ide,代码规范,插件)