真正能通过阿⾥规约的IDEA⽅法注释模板
1. File–>Settings–>Editor–>Live Templates (我们常⽤的⽅法注释快捷键 /**+Enter,这⾥我们也按照这种习惯来设置IDEA的⽅法
注释)
2. 点击+号选择Template Group 写上分组名称,选中分组然后创建⼀个新的⽅法模板,取名,描述. 这⾥有⼀点需要注意的就是设置快捷
键,idea 默认的快捷键不适⽤我们,这个时候我们就直接把⽅法名那⾥写成 ⼀个星, 然后描述随便写,然后⽣成模板的时候就是
/**+Enter
3. 模板内容(直接复制就⾏了,别问什么⼀颗* 两颗星了,保证能⽤)(这⾥我⼜改了⼀下,不要@Decription注解 直接空⼀⾏ 要不然这个过不
去)
*
*
* @Author: author
* @Date: $date$ $time$
$param$
$return$
idea的快捷键**/
4. 还有就是设置这个⽅法模板的使⽤范围.(记着先设置这个,再设置参数数据)
点击模板页⾯最下⽅的警告,来设置将模板应⽤于那些场景,⼀般选择EveryWhere–>Java即可
(如果曾经修改过,则显⽰为change⽽不是define)
5. 这个时候点击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.si ze(); 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());
6. 最后的效果就是这样的: 变量都是亮亮的.