阿里代码规范插件Alibaba Java Coding Guidelines


为了让开发更加方便、更为规范,阿里巴巴基于手册内容,研发了一套自动化的代码规范检测插件Alibaba Java Coding Guidelines 。该插件在扫描代码后,将不符合规约的代码按Blocker/Critical/Major三个等级显示在下方,甚至在IDEA上,我们还基于Inspection机制提供了实时检测功能,编写代码的同时也能快速发现问题所在。

1:在线安装

打开IDEA,File-> Settings->Plugins->Browse Repositories,在Browse Repositories搜索栏搜索Alibaba Java Coding Guidelines,然后安装
阿里代码规范插件Alibaba Java Coding Guidelines

2:离线安装

2.1: zip下载

下载自己喜欢的zip版本,下载地址: https://plugins.jetbrains.com/plugin/10046-alibaba-java-coding-guidelines/versions.
阿里代码规范插件Alibaba Java Coding Guidelines

2.2: 安装zip包

打开IDEA,File->Settings->Plugin->Install plugin from disk,选择刚才自己下载插件zip包的地址,(最好存放的目录路径全英文,我不知道有中文路径是否会出错 哦)。
阿里代码规范插件Alibaba Java Coding Guidelines

3: 如何使用

阿里代码规范插件Alibaba Java Coding Guidelines

3.1: 编码规约扫描

如果点击当前的项目,则扫描当前项目下的所有不合规范的,如果点击某一个类,然后再点击编码规约扫描则扫描的是当前类的不合规范的。该插件在扫描代码后,将不符合规约的代码按Blocker/Critical/Major三个等级显示在下方。
Blocker:阻塞剂,立即改。
Critical:关键,马上改。
Major:重大,稍晚一点改。
阿里代码规范插件Alibaba Java Coding Guidelines

3.2: 实时的监控开关

如果开启,我们在写代码的时候就能够实时的监控到不合规定的写法,更加方便快捷。

3.3: 语言的选择

阿里的这个插件默认的是中文的,所以会更方便我们的使用。当然,也有英文版的,如果你喜欢,也可以切换为英文。

3.4: 自定义不合法规则

File->Settings->Editor->inspections,可以根据自己要求进行选择约束。
阿里代码规范插件Alibaba Java Coding Guidelines