实现的效果如下:
给java中的method添加方法:
/** * * @method : addmenu * @description : * @param menu : * @return : cn.yiyizuche.common.base.resultmsg * @author : rush.d.xzj * @createdate : 2017-06-12 星期一 18:17:42 * */public resultmsg addmenu(menu menu){ resultmsg result = null;return result; }
给 java class 添加注释:
/** * * @project : 壹壹oa * @package : cn.yiyizuche.common.ou.menu.controller * @class : menucontroller * @description : * @author : rush.d.xzj * @createdate : 2017-06-12 星期一 18:15:32 * @version : v1.0.0 * @copyright : 2017 yizukeji inc. all rights reserved. * @reviewed : * @upatelog : name date reason/contents * --------------------------------------- * *** **** **** * */public class menucontroller { }
给js 的方法添加注释
/** * * @method : standardshowbatchcheckbox * @description : * @return : * @author : rush.d.xzj * @createdate : 2017-06-12 星期一 18:15:21 * */function standardshowbatchcheckbox(jspelement, datalist, max, valueidfunction, textfunction, selectedfunction) { }
现在把答案公布如下
abbreviation:
cmj
template text(注1):
** *$context$ */
edit variables:
$context$的代码(主要代码)如下:
groovyscript(def methodname = \${_1}\; def jsmethodname = \${_2}\; def outputmethodname = \${_3}\; def outputdesc = \${_4}\; def outputparams = \${_5}\; def outputauthor = \${_6}\; def outputreturntype = \${_7}\; def outputdatetime = \${_8}\; def outputpackage = \${_9}\; def outputclass = \${_10}\; def outputclassotherinfo = \${_11}\; def outputproject = \${_12}\; def outputversion = \${_13}\; def outputjsmethodname = \${_14}\; def outputjsreturntype = \${_15}\; def result = ''; if (methodname != 'null') { result += '\\n'; result += outputmethodname; result += outputdesc; result += outputparams; result += outputreturntype; result += outputauthor; result += outputdatetime; result += ' *'; return result; } else if (jsmethodname != 'null') { result += '\\n'; result += outputjsmethodname; result += outputdesc; result += outputjsreturntype; result += outputauthor; result += outputdatetime; result += ' *'; return result; } else { result += '\\n'; result += outputproject; result += outputpackage; result += outputclass; result += outputdesc; result += outputauthor; result += outputdatetime; result += outputversion; result += outputclassotherinfo; result += ' *'; return result; } , methodname(), jsmethodname(), groovyscript(def methodname = \${_1}\; def result = ' * @method : ' + methodname + '\\n'; return result;, methodname()), groovyscript(def result = ' * @description : ' + '\\n'; return result;), groovyscript(if(\${_1}\.length() == 2) { return ''; } else { def result=''; def params=\${_1}\.replaceall('[\\\\[|\\\\]|\\\\s]', '').split(',').tolist(); for(i = 0; i < params.size(); i++) { result+=' * @param ' + params[i] + ' : ' + '\\n' }; return result;}, methodparameters()), groovyscript(def author = 'rush.d.xzj'; def result = ' * @author : ' + author + '\\n'; return result;), groovyscript(def returntype = \${_1}\; def result = ' * @return : ' + returntype + '\\n'; return result;, methodreturntype()), groovyscript(def date = \${_1}\; def time = \${_2}\; def result = ' * @createdate : ' + date + ' ' + time + '\\n'; return result;, date(yyyy-mm-dd e), time(hh:mm:ss)), groovyscript(def currentpackage = \${_1}\; def result = ' * @package : ' + currentpackage + '\\n'; return result;, currentpackage()), groovyscript(def classname = \${_1}\; def result = ' * @class : ' + classname + '\\n'; return result;, classname()), groovyscript(def result = ' * @copyright : 2017 yizukeji inc. all rights reserved.' + '\\n'; result += ' * @reviewed : ' + '\\n'; result += ' * @upatelog : name date reason/contents' + '\\n'; result += ' * ---------------------------------------' + '\\n'; result += ' * *** **** **** ' + '\\n'; return result;), groovyscript(def result = ' * @project : 壹壹oa' + '\\n'; return result;), groovyscript(def result = ' * @version : v1.0.0' + '\\n'; return result;), groovyscript(def jsmethodname = \${_1}\; def result = ' * @method : ' + jsmethodname + '\\n'; return result;, jsmethodname()), groovyscript(def result = ' * @return : ' + '\\n'; return result;))
使用如下:
在xx.java或者 xx.js中输出(注2):
/cmj
后 按 tab键(此键是默认的,可以更改成其他的)
注1 和注2
也可以换成第二种方法(网上大部分的方法):
template text
* *$context$ */
跟注1比较第一行少了一个*,
因此注2就是变成了:
/*cmj
我感觉用我的方法比第二种方法好.
edit variable中代码详解
首先我分解了如下的 10几个函数(是小函数):
// 输出方法名groovyscript(def methodname = \${_1}\; def result = ' * @method : ' + methodname + '\\n'; return result;, methodname()) // 输出描述 groovyscript(def result = ' * @description : ' + '\\n'; return result;) // 输出参数列表的子函数 groovyscript(if(\${_1}\.length() == 2) {return ''; } else { def result=''; def params=\${_1}\.replaceall('[\\\\[|\\\\]|\\\\s]', '').split(',').tolist(); for(i = 0; i < params.size(); i++) {result+=' * @param ' + params[i] + ' : ' + '\\n'}; return result;}, methodparameters()) // 输出 作者的 子函数 这里可以改作者 groovyscript(def author = 'rush.d.xzj'; def result = ' * @author : ' + author + '\\n'; return result;) // 输出 返回值的 子函数 groovyscript(def returntype = \${_1}\; def result = ' * @return : ' + returntype + '\\n'; return result;, methodreturntype()) // 输出 日期的 字函数, 这个可以更改日期格式 groovyscript(def date = \${_1}\; def time = \${_2}\; def result = ' * @createdate : ' + date + ' ' + time + '\\n'; return result;, date(yyyy-mm-dd e), time(hh:mm:ss)) // 输出project groovyscript(def result = ' * @project : 壹壹oa' + '\\n'; return result;) // 输出package groovyscript(def currentpackage = \${_1}\; def result = ' * @package : ' + currentpackage + '\\n'; return result;, currentpackage()) // 输出class groovyscript(def classname = \${_1}\; def result = ' * @class : ' + classname + '\\n'; return result;, classname()) // 输出copyright/reviewd/updatelog groovyscript(def result = ' * @copyright : 2017 yizukeji inc. all rights reserved.' + '\\n'; result += ' * @reviewed : ' + '\\n'; result += ' * @upatelog : name date reason/contents' + '\\n'; result += ' * ---------------------------------------' + '\\n'; result += ' * *** **** **** ' + '\\n'; return result;) // 输出version groovyscript(def result = ' * @version : v1.0.0' + '\\n'; return result;) // 输出jsmethodname groovyscript(def jsmethodname = \${_1}\; def result = ' * @method : ' + jsmethodname + '\\n'; return result;, jsmethodname()) // 输出 js 的return groovyscript(def result = ' * @return : ' + '\\n'; return result;)
然后在主要代码中,需要把上述的10几个函数当做参数供给主要代码使用.
判断是函数,类,js函数主要是通过如下的2个内置变量来实现的:
methodname() jsmethodname()
当methodname()不为空的时候, 生成 方法的 注释
当jsmethodname()不为空的时候, 生成 js方法的注释
否则生成类的注释
所以上述的代码可以简单的做如下的归类了:
获取相关参数:
def methodname = \${_1}\; def jsmethodname = \${_2}\; def outputmethodname = \${_3}\; def outputdesc = \${_4}\; def outputparams = \${_5}\; def outputauthor = \${_6}\; def outputreturntype = \${_7}\; def outputdatetime = \${_8}\; def outputpackage = \${_9}\; def outputclass = \${_10}\; def outputclassotherinfo = \${_11}\; def outputproject = \${_12}\; def outputversion = \${_13}\; def outputjsmethodname = \${_14}\; def outputjsreturntype = \${_15}\; def result = '';
判断是哪一种类型的注释(代码片段2):
if (methodname != 'null') { result += '\\n'; result += outputmethodname; result += outputdesc; result += outputparams; result += outputreturntype; result += outputauthor; result += outputdatetime; result += ' *';return result; } else if (jsmethodname != 'null') { result += '\\n'; result += outputjsmethodname; result += outputdesc; result += outputjsreturntype; result += outputauthor; result += outputdatetime; result += ' *';return result; } else { result += '\\n'; result += outputproject; result += outputpackage; result += outputclass; result += outputdesc; result += outputauthor; result += outputdatetime; result += outputversion; result += outputclassotherinfo; result += ' *';return result; }
这下就可以了.就把整个这么难看(groopscript搞的?)代码整理的比较清晰了.
我还有如下的几个疑惑/问题需要解决, 如果有朋友能给我答案那就好了.
问题1. 不知道可以通过什么方法获取js方法中的参数列表
问题2. 代码片段2中如果我改成了:
result += '\\n';if (methodname != 'null') { result += outputmethodname; result += outputdesc; result += outputparams; result += outputreturntype; result += outputauthor; result += outputdatetime; } else if (jsmethodname != 'null') { result += '\\n'; result += outputjsmethodname; result += outputdesc; result += outputjsreturntype; result += outputauthor; result += outputdatetime; } else { result += '\\n'; result += outputproject; result += outputpackage; result += outputclass; result += outputdesc; result += outputauthor; result += outputdatetime; result += outputversion; result += outputclassotherinfo; } result += ' *';return result;
会出现如下的错误:
startup failed: script1.groovy: 1: expecting eof, found 'result' @ line 1, column 1036. lt += outputclassotherinfo; } result += ^ 1 error
问题3: 不知道怎么获取override方法对应的接口方法(父类方法)
关于问题3: 实际上给这种方法加注释是没有意义的,具体可以参考:
但是如果非要加该怎么去判断.
最后可以把 缩写(abbreviation) 改成: *
这样以后只需要输入:
/*
然后按一下 tab 键就出现结果了
哈哈!!!
以上就是idea live template高级知识, 进阶的详细内容。