Idea设置java类方法注释模板

工具 / 2021-12-27

1,类注释:*File-->Settings-->*Editor-->File and CodeTemplates

img

模板:

/**
 * @description:
 * @author: ${USER}
 * @date: ${DATE} ${TIME}
 */

2,方法注释:File-->Settings-->Editor-->Live Templates

点击右上角的绿色+号,然后选择Template Group,然后输入group的name,我这里输入:MyGroup,然后点ok

img

选中刚才创建的MyGroup,然后再次点击右侧的绿色+,这次选择的是第一个Live Template。取名为 *****,名字可以根据个人习惯取

配置模板:注意是*开头,不是/**开头

*
 * @description:
 * @author: $user$
 * @date: $date$ $time$
 $params$
 * @return: $return$
 */

编辑好模板之后就为参数添加变量,点击右侧的 Editor variables配置变量

img

对应的模板参数的值:

$user$   user()
$date$   date()
$time$   time()
$params$ 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())methodParameters())
$return$ methodReturnType()

然后点击模板下方的Define,打开界面根据需要选择要生成注释的文件

img

这里做java开发,一般选择java的就可以了,如果编辑之后会变成Change,点击Change可以修改

最后可以通过选择Expand with为方法修改快捷键,默认为Enter,我这修改成了Tab,在方法上输入 /** 然后在按tab键,方法注释就出来了(Enter快捷键和多行注释可能会冲突),使用多行注释时也会使用该模板,所以改为tab键避免冲突。

img

最后效果:

img