IDEA 配置注释模板

目录

一、配置类模板注释

二、配置方法注释

一、配置类模板注释

打开IDEA，打开settings(快捷键：Ctrl + Alt + s)，选择Editor，找到File and Code Templates，设置需要配置注释的文件类型，如下图所示：

选择需要配置注释的文件，填入以下内容：

#if (${PACKAGE_NAME} && ${PACKAGE_NAME} != "")package ${PACKAGE_NAME};#end
#parse("File Header.java")
/**
 * packageName ${PACKAGE_NAME}
 * @author 你的名字
 * @version JDK 8
 * @className ${NAME} (此处以class为例)
 * @date ${DATE}
 * @description TODO
 */
public class ${NAME} {
}

 其他文件类似，按需修改@ClassName为@InterfaceName或者其他即可。

点击Apply后，效果如下：

 

二、配置方法注释

同样是在Editor中，找到Live Templates，如下图所示：

1、在右侧添加Template Group，名字随意，如下图所示：

 

 2、 在刚添加的Group中添加Live Template，如下图所示：

 内容填写如下：

        Abbreviation中填写描述缩写；

        Description 填写此Template的描述，任意字符都可；

        右侧Options下面的勾选上；

        右侧的Options选择Enter，含义为：方法签名写好后，输入/**后按Enter生成注释；

 最下面的警告选择Java，如下图所示：

 在Template text中填入以下内容：

*
 * $var$
 $params$ * return $returns$
	* {@link $returns$}
 * @author 你的名字
 * @date $date$	
 * @description 
 */

具体内容可以再自行添加或修改。

然后点击右侧的Apply，再点击Edit variables，如下图：

 Edit variables的内容如下：

 var脚本如下：

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

returns脚本如下：

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

最后Apply，效果如下：