IDEA 设置类和方法注释模板

• 2020 年 3 月 8 日
• 筆記

设置类模板

位置

File -> Settings -> Editor -> File and Code Templates

选择 Includes

创建文件头

点击 “+”，改名为 File Header，内容如下

/**   * @Description: ${DESCRIPTION}   *   * @Author ${USER}   * @Date ${DATE} ${TIME}   * @Version 1.0   */

设置方法注解模板

位置

File -> Settings -> Editor -> Live Templates

创建组

点击 “+”，Create New Group，输入【自定义组名，例如 userDefine】

创建模板

点击 “+”，Live Template

配置模板

Abbreviation：设置模板名称，建议就是 * 号

Description：模板描述，可选

Template text：模板，注意开头是没有 /* 的

*   * @Description: $END$   * @Author: $user$   * @Date: $date$ $time$   $param$   $return$   **/

设置模板的应用场景

点击模板页面最下方的警告，来设置将模板应用于那些场景，一般选择 EveryWhere -> Java 即可

设置参数的获取方式

点击 Edit variables

Skip if defined

建议打勾，不然每次创建，都会先跳到上面每个参数，优先修改此参数

param Default value

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

return Default value

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