idea之自定义注释模板

类注释模板设置

1.File-->settings-->Editor-->File and Code Templates-->Files

2.选择Class/Interface文件来设置模板，格式如下：

/**
  *@ClassName ${NAME}
  *@Description TODO
  *@Author eflyings
  *@Date ${DATE} ${TIME}
  *@Version 1.0
  **/
public class ${NAME} {
}

（1）${NAME}：设置类名，与下面的${NAME}一样才能获取到创建的类名

（2）TODO：代办事项的标记，一般生成类或方法都需要添加描述

（3）Author eflyings: 作者，这里写死了

（3）${DATE}、${TIME}：设置创建类的日期和时间，使用IDEA内置的方法

（4）Version 1.0：设置版本号，一般新创建的类都是1.0版本，可以写死

3.效果图

方法注释模板设置

1、File-->Settings-->Editor-->Live Templates

2.添加模板

1）新建组：点击上图中的模板组 “Template Group”，命名为“eflyings”

2）新建模板：点击上图中的模板“Live Template”来新建模板，命名为“*”

IDEA生成注释的默认方式是：/*+模板名+快捷键（比如若设置模板名为*快捷键用Enter，则生成方式为/**+Tab），如果不采用这样的生成方式IDEA中没有内容的方法将不可用，例如获取方法参数的methodParameters()、获取方法返回值的methodReturnType()

3）添加模板内容

*
 * TODO
 * @Author eflyings
 * @Date $time$ $date$
$param$
 * @return $return$ 
 **/

4）模板内容中参数设置及获取

$param$参数直接使用IDEA自带的表达式methodParameters()，会导致结果中@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$参数直接使用IDEA自带的表达式methodReturnType()，会导致结果中@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())

5）设置生成注释的快捷键

6）设置模板的应用场景

7）效果图

/**
 * TODO
 * @Author eflyings
 * @Date 18:59 2021-5-27
 * @param pageNo
 * @param pageSize
 * @return Paging<DeliveryFeeTemplateDetailDTO> 
 **/