idea live template

Posted 2020-09-22 传说中的汽水枪

 

最近正在研究如何给idea添加注释模板. 此篇文章是记录在写(开发)注释模板的过程中遇到的坑.

---

 

1. methodParameters()

当函数的参数列表为空的时候返回的是:

[]

当函数的参数列表不为空的时候返回的是:

[name, key, page]

---

2. 有的时候修改参数的Expression的时候, 会出现修改不了的时候(修改完毕,再点一次刚刚修改的又自动变回去了), 这个时候可以强行输入修改,然后按一下回车就可以了.

现在在如下情况遇到的:

默认的是: date()

想修改成:  date("yyyy-MM-dd")

可以先选中那个变量编辑框, 然后手动输入date("yyyy-MM-dd")后, 按一下回车就可以了.

---

 

3 一个完整的给Java函数注释模板

Template text:

**
 *
 * @Method : $methodName$
 * @Description : $params$
 * @return : $methodReturnType$
 * @author : Rush.D.Xzj
 * @CreateDate : $date$ $time$
 *
 */

参数列表及值:

methodName
methodName()

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

methodReturnType
methodReturnType()

date
date("yyyy-MM-dd")

time
time("HH:mm:ss")

缩写我定义成了如下:

cm.m

在实际的Java代码使用如下:

输入   

/cm.m

后按一下tab键(回车键也可以)

 

示例代码如下:

    /**
     *
     * @Method : testReturn
     * @Description : 
     * @return : java.lang.String
     * @author : Rush.D.Xzj
     * @CreateDate : 2017-06-12 11:54:03
     *
     */
    public String testReturn() {
        return "abc";
    }
    
    
    /**
     *
     * @Method : testMultParams
     * @Description : 
     * @param i : 
     * @param j : 
     * @param abc : 
     * @return : void
     * @author : Rush.D.Xzj
     * @CreateDate : 2017-06-12 11:54:10
     *
     */
    public void testMultParams(int i, int j, String abc) {
        
    }