【IDEA】简单使用类注释，方法注释模板

【IDEA】类注释，方法注释模板

1、类注释

1.1 打开 File and Code Template界面

快捷键：Ctrl + Alt + S 打开设置界面，搜索 “template”,选中 Editor菜单栏下面的 File and Code Templates。

2. 添加下面代码模板

/**
 * @Description: ${NAME}
 * @Author: zr 
 * @Date: ${YEAR}-${MONTH}-${DAY}
 * @Version:v1.0
 */

具体使用什么模板，可以自己进行定制化设置

2、方法注释

2.1 打开 live Templates界面

快捷键：Ctrl + Alt + S 打开设置界面，搜索 “live”,选中 Editor菜单栏下面的 live Templates。

我是直接放在user template group下，你也可以自己新建。

如图：

2.2 添加 方法注释 代码模板

1. 设置缩写，设置注释（也可以不设置）

Abbreviation: *
Description:

2.3 设置代码模板

**
 * @Desc: $start$
 $param$
 * @Return $return$ 
 * @Date: $date$
 */

如图：

2.4 设置模板中的参数

• start：什么都不用设置。
• param：default value 设置

groovyScript("def result=''; def params=\"${_1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split(',').toList(); for(i = 0; i < params.size(); i++) {if(i==0){result ='* @Param ' + params[i] + ((i < params.size() - 1) ? '\\n' : '');}else{result +='	* @Param ' + params[i] + ((i < params.size() - 1) ? '\\n' : '');}}; return result", methodParameters())

• return：选择methodReturnType(）方法。
• date：选择date()方法。

2.5 设置生成方法注释的快捷键

觉得有用的话，点个赞呗！！！