IDEA 设置注释生成多参数params格式
是这样的:
公司内部对注释有一定的格式规范要求,如下:
/**
* @param
* @return
* @author
* @date
*/
在参考了别人的文章之后,自己做了一些简单的修改、在此记录下来,以供参考
ctrl + alt + s 打开 settings ,新建 Template Group
新建一个 live 模板
添加信息:
Abbreviation: 模板名,在代码中添加注释模板的时候使用。
Expand with:在输入模板名之后, 按键触发。应用语言设置
编辑模板
这里注意一点:
模板的第一个*
之前不加/
*
* @Description:
*
$params$
* @return: $return$
* @Author: hello
* @Date $date$ $time$
*/
如果 前面加 /
, 会导致 获取参数的方法:methodParameters() 失效。 这个具体原因不懂。。。
- 最后编辑变量
开始时对变量 params 使用的是IDEA自带的方法。但效果一般,在含有多个参数的时候,只能生成一个参数注释,其它注释需要自己添加、很是费劲。 后来上网查了一下自写的方法,我修改了一下,如下:
groovyScript("def result=''; def params=\"${_1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split(',').toList(); for(i = 0; i < params.size(); i++) { result+='* @param: ' + params[i] + ((i < params.size() - 1) ? '\\n ' : '')};return result", methodParameters())
在方法上输入:/**
然后按 enter
显示结果如下:
方法代码解释:
methodParams()
: 是IDEA自带的获取方法中参数的方法。
def params=\"${_1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split(',').toList()
: 处理获取到的参数字符串。
版权声明:本文为weixin_44504563原创文章,遵循CC 4.0 BY-SA版权协议,转载请附上原文出处链接和本声明。