有了这个插件,再也不用担心代码不合规范了

Posted Hollis Chuang

tags:

篇首语:本文由小常识网(cha138.com)小编为大家整理,主要介绍了有了这个插件,再也不用担心代码不合规范了相关的知识,希望对你有一定的参考价值。

工作这么多年,有个软件一直在用,那就是 IDEA,这是宇宙最好用的 Java IDE,没有之一!

IDEA 的开放能力做的还不错,可以添加很多插件,让我们的很多开发工作更加便捷。

我装的插件其实没几个,但有一款是一直以来在用的,那就是——阿里巴巴代码规约插件。

这个插件呢,是阿里巴巴基于《阿里巴巴 Java 开发手册》中的内容,研发出的一套自动化的 IDE 检测插件。

目前插件实现了开发手册中的 53 条规则,大部分基于 PMD 实现,其中有 4 条规则基于 IDEA 实现,并且基于 IDEA Inspection 实现了实时检测功能。部分规则实现了Quick Fix 功能,对于可以提供 Quick Fix 但没有提供的,p3c 团队在努力实现中。目前插件检测有两种模式:实时检测、手动触发。

话不多说,我们来看看这个插件如何安装和使用!

安装

IDEA 插件页搜索 alibaba,选择 Alibaba Java Coding Guidelines 进行安装,安装后重启 IDEA。

使用

可以看到菜单栏-Tools 里多了「阿里编码规约」,该插件可以扫描出代码中不符合规约的部分,默认开启实时监测,当然也可以手动关闭。

比如我当前类,没有作者信息,该规约插件就会提醒我。

也可以在编辑器里右键点击「编码规约扫描」,我们可以看到检测结果。结果分三个等级,每个等级里都有相应的检测项信息,详细解释了不符合规约的代码块以及原因。

比如最严重的 Blocker 等级里就有一项long 类型初始赋值的问题。

Critical 等级里有一项抽象类命名的问题。

Major 等级里有一项行尾注释的问题。

基于检测提示,开发同学可以做出相应的代码优化,也有助于良好编码习惯的养成!还没用过的朋友赶紧来试试吧!

插件和规约手册都可以在阿里官方的 GitHub 找到,地址如下:https://github.com/alibaba/p3c

有道无术,术可成;有术无道,止于术

欢迎大家关注Java之道公众号

好文章,我在看❤️

以上是关于有了这个插件,再也不用担心代码不合规范了的主要内容,如果未能解决你的问题,请参考以下文章

Idea代码自动补全,良心插件推荐:Codota,再也不用担心写不出代码了。

Idea代码自动补全,良心插件推荐:Codota,再也不用担心写不出代码了。

Idea代码自动补全,良心插件推荐:Codota,再也不用担心写不出代码了。

同步vscode配置和插件导入导出再也不用担心换电脑重新安装插件了!

android 傻瓜式 MultiDex 插件,从此再也不用担心方法数问题!

再也不用担心不会webpack了