IDEA 设置类注释和方法注释模板
一、新建类,自动生成类注释
类注释模板:
/***
* @ClassName ${NAME}
* @Description TODO
* @Author ${USER}
* @Date ${DATE} ${TIME}
* @Version 1.0
*/
效果如下:
二、已有的类,使用快捷键生成类注释
操作步骤:
1)新建Template Group
2)在新建的Group下创建Live Template
3)Abbreviation:可根据自身习惯修改,不要使用/**,会和方法注释快捷键冲突。
4)Description:自定义模板名称
5)Template text:
/***
* @ClassName $NAME$
* @Description TODO$START$$END$
* @Author $USER$
* @Date $DATE$ $TIME$
* @Version 1.0
*/
6)Edit Variables:
7)Expand with:Enter
效果如下:
三、使用快捷键,生成方法注释
1)Abbreviation:*
2)Description:自定义模板名称
3)Template text:
*
* TODO$START$ $param$ $return$
* @author $USER$
* @date $date$
*/
4)Edit Variables:
param如下:
groovyScript("def result=''; def stop=false; def params=\"${_1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split(',').toList(); if (params.size()==1 && (params[0]==null || params[0]=='null' || params[0]=='')) { stop=true; }; if(!stop) { for(i=0; i < params.size(); i++) {if(i==0) result += '\\n'; result +=((i < params.size() - 1) ? ' * @param ' + params[i] + '\\r\\n' : ' * @param ' + params[i] + '')}; }; return result;", methodParameters())
return如下:
groovyScript("def result=''; def data=\"${_1}\"; def stop=false; if(data==null || data=='null' || data=='' || data=='void') { stop=true; }; if(!stop) { result += '\\n'; result += ' * @return ' + data; }; return result;", methodReturnType())
5)Expand with:Enter
效果如下: