在项目开发中需要对写的类或方法添加注释,便于后续对代码的阅读和理解,默认的注释不满足的情况下可以自己重新定义注释。
一、打开idea找到File—>Settings—>Editor---->Live Templates
二、建立分组,注意这里选择Template Group
三、添加模板
设置模板:
1、Abbreviation设置为**
2、Description:设置备注
3、No applicable contexts:设置成java
4、Expand with :设置成Enter
5、Template test:设置模板内容
**
*
*
* @author yjb
*/
然后保存,在类的前面输入/**然后回车,注释就添加成功了;
四、在方法上添加自定义注释
1、Abbreviation设置为*
2、Description:设置备注
3、No applicable contexts:设置成java
4、Expand with :设置成Enter
5、Template test:设置模板内容
**
*
*
* @author yjb $param$ $return$
*/
6、添加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++) {result +=((i==0) ? '\\r\\n' : '') + ((i < params.size() - 1) ? ' * @param ' + params[i] + '\\r\\n' : ' * @param ' + params[i] + '')}; }; return result;", methodParameters())
7、添加return字段
groovyScript("def result=''; def data=\"${_1}\"; def stop=false; if(data==null || data=='null' || data=='' || data=='void' ) { stop=true; }; if(!stop) { result += '\\r\\n' + ' * @return ' + data; }; return result;", methodReturnType())