[工具] 在 idea 中使用阿里巴巴代码规范插件及快捷注释的配置

一、idea 中阿里巴巴代码规范插件的作用

1. 一套统一的准则

   大家都用统一的、经过前辈检验总结后的准则,这样避免了代码整理时容易发生的争执。而且统一的注释规范,大家互相看着也方便。

2. 检测到不合规范的代码块会自动提示
if或者else没有添加大括号
接口方法必须要有注释
3. 在 idea 中能把部分代码通过 Alt + Enter 直接更正
if else注释.gif
添加作者注释.gif
4. 在 idea 通过配置注释快捷键可以快速给出符合规范的注释
接口的快速注释.gif

二、在 idea 中安装阿里巴巴代码规范插件

1. 打开 File --> Settings
搜索阿里巴巴插件

alibaba插件直接弹出来了

点击 Restart,关闭本页面,确认重启 idea
2. 设置注释快捷键
(1) 新创建文件时,在头部自动添加信息
新文件头部注释
/**
 * @author 你的名字
 * @date ${DATE} ${TIME}
 */
新创建的文件已经自动添加上注释了
(2) 配置快捷键注释 (关键)

a. 创建新的模板组

创建新的模板组

输入新的模板组的名字

在模板组中新增模板

b. 新的模板

**
 * description: 
 * 
$param$ 
 * @return $return$
 */
填入新的模板的信息

param 填入的表达式

groovyScript(
        "def result=''; 
        def params=\"${_1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split(',').toList(); 
        for(i = 0; i < params.size(); i++) {
            result +=' * @param ' + params[i] + ((i < params.size() - 1) ? '\\n' : '')}; 
            return result ", methodParameters())

idea的一个BUG,如果在复制 groovyScript() 的时候经常复制不上去,那么你需要在Expression中复制groovyScript() 后立即按 CTRL + S

配置变量

最后一步

到此,差不多都配置好了。

(2) 快捷键的使用
  • 如果某个单词下方出现~~~代表不合规范,不严重的波浪线是浅黄色,严重的波浪线是红色。
    • 可以把鼠标移到该单词上,看它提示啥信息。提示的信息对应着阿里巴巴 Java 编程规范。
    • 也可以点击该单词,把光标位置移到波浪线出现的位置,然后 Alt + Enter,然后各种操作。
  • 在接口的方法上 输入 /* 按下 Tab 键,注释就自动出来了
接口的快速注释.gif

有问题欢迎评论,希望对你有帮助。

完。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 210,978评论 6 490
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 89,954评论 2 384
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 156,623评论 0 345
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,324评论 1 282
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 65,390评论 5 384
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,741评论 1 289
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,892评论 3 405
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,655评论 0 266
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,104评论 1 303
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,451评论 2 325
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,569评论 1 340
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,254评论 4 328
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,834评论 3 312
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,725评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,950评论 1 264
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,260评论 2 360
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,446评论 2 348

推荐阅读更多精彩内容