IDEA 开发工具 注释模板配置

 

 

由于工作要求，需要仿照MyEcplise用IDEA配置对应的【注释模板】，接下来是具体的配置方法与步骤：

 

 

• 普通类注释模板（方法注释模板和这个不一样）

1. 打开File->Settings->Editor,点击File and Code Templates
2. 选择Includes，并找到绿色的【+】，新添加一个模板
3. 在右侧的空白处即可填写自己想要的模板

PS：   看清楚函数的写法${DATE}  而不是$DATE$  ；这个模板会在我们新建Java类的时候自动执行

附上我的模板：

/*
 * 描述：
 * 作者：XXX 
 * 日期：${DATE}
 */

 

---

• 方法注释模板

        1、打开File->Settings->Editor,点击Live Templates

        2、找到绿色的【+】，选择Template Group 建立模板组，名字随意（详细见  图片1）

                                                                                        图片1

        3、在我们新创建的模板组中添加模板，找到绿色的【+】，选择Live Template （ 详细见  图片2）

                                                                                                       图片2

        4、填好之后，我们会发现填好的 模板格式 并不是灰色的，我们需要关联一下应用场景即可

        5、点击最下面的   蓝色的【Define】，在弹出的下拉框中勾选Java即可

        6、填好信息之后需要找到【Edit variables】按钮，为我们在模板里写的函数关联起来（很重要）

        7、在模板中写的函数（这里的函数格式是：$date$）都会映射到这里，我们在Expression中选择与之对应的函数即可

        8、常用的函数就是    日期：date()   参数： methodParameters()   返回值：methodReturnType()

                                                                                                       图片3

        9、一系列都完成之后我们就可以使用该模板了，其具体用法是  输入 模板关键字（/..）+模板执行快捷键（Enter）即可

PS：不过尴尬的是需要在方法内部执行，切记这里说的是方法内部，因为methodParameters()的作用域只在方法内部。

/**
 * 功能：
 * 作者：Jx 
 * 日期：$date$
 * @Param $param$
 * @Return $return$
 */

methodParameters 和 methodReturnType 都可以重写，附上我的两个方法：

            methodParameters :

groovyScript("def result=''; def params=\"${_1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split(',').toList(); for(i = 1; i < params.size() +1; i++) {result+= ((i == 1) ?  params[i - 1] : '* @Param '+params[i - 1]) + ((i < params.size()) ? '\\n ' : '')}; return result", methodParameters())

            methodReturnType :

 groovyScript("def result=\"${_1}\"; if(result == \"void\"){return \"\";}else{return \"{@link \"+result+\"}\";}", methodReturnType())