最近使用IDEA注释的时候发现方法注释有些坑,没办法网上搜索了好多,大多都是摘抄的没有完美解决。下面整理了下方法注释的完美解决方案,本文经过自己亲自验证有效。
- File->settings->Editor->Live Templates
- 点击右上角的绿色+号,然后选择template group ,然后输入group的name,随便输入就好了:myGroup。然后点ok
- 选中刚才创建的myGroup,然后再次点击右侧的绿色+,这次选择的是第一个1. Live Template。取名为*,取名可以随便,只是个人觉得方便,你可以取别的。
- 配置模板,下面是我的模板,大家仔细看我的模板开头是*而不是/*,这就是关键所在。
注意:只有当变量被$$包围时 右侧的Edit variables才可以点击哦。* * @Description: TODO $tags$ * @return $return_type$ * @author xcc * @date $date$ $time$ */
- 再编辑好模板之后就只为参数添加$$添加变量,点击右侧的 Editor variables,
- 其中参数的Expression为groovyScript脚本,具体如下:
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\\b' : '')}; return result", methodParameters())
要不然参数就会出现[XXX, XXX]这种格式,不实用,至少不符合我的要求。
- 完成之后点击Apply然后点击OK,注意了,重点的地方,在你的方法上输入 /*然后加上模板的名称*,这就是我为什么不取字母而取名为*,因为这样很快速,再按Enter键就会出现你想要的注释了,很多教程是直接输入模板名称按tab键,但是这种方法的@param和@return是获取不到的;如果你取名为abc那就是 /*abc 然后按Enter。效果如下:
至此已大功告成了,希望能帮到大家!