Idea配置注释模板

一、配置类注释模板

打开IDEA，打开settings(快捷键：Ctrl + Alt + s)，选择Editor，找到File and Code Templates

这里以设置class文件为例，点击Class，在右侧配置以下内容

#if (${PACKAGE_NAME} && ${PACKAGE_NAME} != "")package ${PACKAGE_NAME};#end
#parse("File Header.java")
/**
 * @Description: TODO
 * @Author: xxx
 * @Date: ${YEAR}-${MONTH}-${DAY} ${HOUR}:${MINUTE}:${SECOND}
 */
public class ${NAME} {
}

点击Apply应用，效果如下

二、配置实时模板

打开设置settings(快捷键：Ctrl + Alt + s)，在Editor中找到Live Templates

点击“+”，选择“Template Group”新建一个自定义的group

输入一个自定义的group名称

找到新建的Group，点击“+”，选择“Live Template”，添加模板

1.方法注释模板

Abbreviation填*，description随意，Template Text填以下内容

*
$param$
 * @return $return$
 * @description TODO
 */

点击“Edit variables”配置变量

勾选Skip if defined

return下拉选择**methodReturnType()**方法，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) ? '\\r\\n' : '')}; return result", methodParameters())

Expand with 选择 “Enter”

应用到java文件


点击Apply生效，效果如下

2. 类注释模板

Abbreviation填/，description随意，Expand with 默认Tab，Template Text填以下内容

/**  
 * @description TODO
 * @author xxx
 * @date $DATE$ $TIME$
 */

编辑变量

应用到java文件，点击Apply