IDEA自动生成注释模板的配置教程_Java

项目场景

idea自动生成注释模板配置方法（包括类模板和方法模板）

配置方法

类注释模板

根据图片的步骤，进入设置类注释模板处进行修改填入相应内容。
file ——> settings ——> editor ——> file and code templates ——>file header

定义类开头的注释

/**
*@belongsproject: ${project_name}
*@belongspackage: ${package_name}
*@author: xxxx
*@createtime: ${year}/${month}/${day}  ${hour}:${minute}
*@description: todo
*@version: 1.0
*/

在这个模板中，我们使用了
$ {project_name}、$ {package_name}、$ {year}、$ {month}、$ {day}、$ {hour} 和
$ {minute} 内置的模板变量来自动生成当前项目名称、包名以及当前日期和时间。您可以在模板中编辑其他信息，如作者名、描述等。

步骤

在这里插入图片描述

类注释效果

在这里插入图片描述

方法注释模板

根据图片的步骤，进入设置类注释模板处进行修改填入相应内容。
file ——> settings ——> editor ——> live templates

定义方法开头的注释

方法注释模板

**
* @description: todo $description$
* @author: llong
* @date: $date$ $time$
$param$
* @return: $return$
**/

注意：修改edit varuavkes中需要定义的参数以及生成方式（如：expand with 为 enter）

date 参数

date("yyyy/mm/dd")

time 参数

time("hh:mm:ss")

param 参数

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 result=''; def params=\"${_1}\".replaceall('[\\\\[|\\\\]|\\\\s]', '').split('<').tolist(); for(i = 0; i < params.size(); i++) {if(i!=0){result+='<';};  def p1=params[i].split(',').tolist();  for(i2 = 0; i2 < p1.size(); i2++) { def p2=p1[i2].split('\\\\.').tolist();  result+=p2[p2.size()-1]; if(i2!=p1.size()-1){result+=','}  } ;  };  return result", methodreturntype())