idea自定义注释模版

一、自定义类注释

打开idea，选择 Settings--> Editor--> File and Code Templates，选择需要添加的文件，如下图所示：

/**

* @description: TODO

* @author morning

* @date ${YEAR}-${MONTH}-${DAY} ${TIME}:${SECOND}

* @version: 1.0

*/

@author 后面跟的是作者名称，可以写成固定的，也可以写成${USER},这种写法会自动获取系统用户名。日期的格式也可根据自己需要自定义，效果如下图：

二、自定义方法注释

1、选择 Settings--> Editor--> Live Templates，添加一个模版，Abbreviation：填模板的缩写，使用*号作为代号（这种自认为最好用且方便），添加Template text如下（注释模板开头不要使用/，一定要严格按照这种格式）

*

* $description$

$params$

$return$

* @author: morning

* @date: $date$ $time$

*/

2、选择下面的Change设置将模板应用于哪些场景, 勾选Java

3、点击Edit variables，会读取刚刚在注释模板中的配置的参数名，按如下模版设置（模版亲测好用）：

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

@return

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

@date

data()

@time

time()

4、在方法上输入/**，然后点击Tab键，注释会自动生成，效果如下：