方法头注释设置
-
新建一个方法头注释模板
-
设置框 5 处和 8 处 的组合是调出方法头注释的快捷键
因为5处设置的是 ’ + ’ ,所以再调用时,可以输入 /+ ,然后按回车,效果就和java代码注释的标准样式就对应了
-
设置框 6 处的代码为:
** * @title $title$ * @Description $description$ * @author e_n $param$ * @return $return$ * @throws $throws$ * @CreateTime $date$ $TIME$ */
注意两点:
3.1 开头是 ** ,不能是 /**
3.2 $param $必须顶头写,因为在第5步中对于param的设置中已经包含了对 “ * param ”头的格式设置
-
设置各注释类型的参数
-
设置框 9 中 param 的参数代码如下:
groovyScript("def result=''; def params=\"${_1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split(',').toList(); for(i = 0; i < params.size(); i++) {if(params.size()==0) result += '\\n'; result+=' * @param ' + params[i] + ((i < params.size() - 1) ? '\\n' : '')}; return result", methodParameters())
特别说明:
-
参考博文:IDEA 配置方法注释@param时自动参数的问题 - 灰信网(软件开发博客聚合) (freesion.com)
-
在param的设置中,将原博文中的第二个if语句的判断条件进行了修改,这样在多参数的情形下,不会多一行空参数的显示
-
$param $必须顶头写
-
显示效果