真正能通过阿里规约的IDEA类、方法注释模板

最新更新日期：2024年8月22日，IDEA版本2023.2

前言：

2020年公司入职培训中，我的项目经理给我培训时，提到阿里开发手册里面的规约，当时我是不怎么重视的。后来维护系统时看到“前辈们”的代码，实在让人难以理解。我觉得这不仅仅是个人能力的问题，花更长的时间我可以看懂。但我可以看懂，但我还是希望高效的维护，空出来的时间去充分的学习（摸鱼）其他的内容。现在我进行新员工入职培训时，也会着重介绍规范的重要性，不仅是代码走查影响业绩，也要保证“前人栽树，后人真乘凉”。

下面正式开始设置，以下的内容按图操作即可。相关数据值可以直接进行复制粘贴使用

1. File–>Settings–>Editor–>Live Templates (我们常用的方法注释快捷键 /**+Enter，这里我们也按照这种习惯来设置IDEA的方法注释)
   

2. 点击图示下键符号号选择Live Template 写上分组名称,选中分组然后创建一个新的方法模板,取名,描述. 这里有一点需要注意的就是设置快捷键,idea 默认的快捷键不适用我们,这个时候我们就直接把方法名那里写成 一个星, 然后描述随便写,然后生成模板的时候就是 /**+Enter
   

3. 模板内容(直接复制就可以，不要使用“@Decription”注解 直接空一行 阿里规约不认这个注解，直接空一行写汉字说明即可)

 5.  6. 
 7. @Author: author
 8. @Date: $date$ $time$
 $param$
 $return$
 **/

9. 还有就是设置这个方法模板的使用范围.(记着先设置这个,再设置参数数据)
   点击模板页面最下方的警告，来设置将模板应用于那些场景，一般选择EveryWhere–>Java即可
   （如果曾经修改过，则显示为change而不是define）
   
   
10. 这个时候点击Edit variables 选择对应的那些数据值 (重点来了:想要符合阿里规约让那些参数和返回值变亮必须设置default value)
    设置的值分别如下：

param:

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

return:

groovyScript("def returnType = \"${_1}\"; def result = '* @return: ' + returnType; return result;", methodReturnType());

这个地方要完全按照我这个配置, 怎么打开窗口有个edit variables 按钮

注意这个地方是Enter

6. 这里说一下黄色提示（主题不同这里可能是波浪线），是因为IDEA认为不认识此名称，强迫症的我们，只需要光标放到对应位置，ALT+Eneter 快捷处理一下就可以
   
7. 最后，展示阶段。（顺便问下，有人喜欢滑头鬼么？）