真正能通过阿里规约的IDEA方法注释方法

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

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

3. 模板内容(直接复制就行了,别问什么一颗* 两颗星了,保证能用)

*
 * @Description:
 * @Author: author
 * @Date: $date$ $time$
 $param$
 $return$
 **/

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.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());

6. 最后的效果就是这样的: 变量都是亮亮的.
   

本文地址：https://blog.csdn.net/qq_40148467/article/details/107653524