最佳的idea注释模板

1. class和interface注释，

关键注释行代码：

/**
 *@Description : TODO
 *@Author : ${USER}
 *@Date : ${DATE} ${TIME}
 *@Version : 1.0
 **/

创建新class后会自动生成注释，如果碰到以前的class没有注释，从下面模板中添加快捷键方式。

2. 快捷键给class生成注释，这里的mygroup是我新建的template group, group里面是同样从这个 + 新建的两个模板，分别是class类注释和function方法注释

3. 快捷键类注释。我比较喜欢用/*开头，同时这里expand with 我改成了enter,输入了/*+enter会自动在类的上面生成这段注释

template text下面代码块：

/**
 *@Description : TODO
 *@Author : $USER$
 *@Date : $DATE$ $TIME$
 *@Version : 1.0
 **/

但是需要给author 和date动态赋值， 点击expand with上面这个 Edit variables， 打开编辑，对应选择即可，然后apply  OK保存。

4. 最重点的方法注释，看下面，解决params, return不返回，或者返回null，或者必须要在方法内部注释才会生成的情况：

上面特别要注意的是，abbreviation 这里是一个 * ， 下面贴template text里代码块：

*
  * @Description: todo
  * @Author: $user$
  * @Date: $date$ $time$
  $params$
  $return$
  * @Version: 1.0        
  **/

点击edit variables配置

其中比较重要的是parms的设置：

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

renturn 的设置：

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

最后，如何使用：

在方法上面输入：/** + enter  ,注意这里是双星号，前面也又斜杠。

效果：

参考内容:https://blog.csdn.net/Aeve_imp/article/details/85785411