intelliJ IDEA Java注释模板配置
主要内容:intelliJ IDEA live template 配置

话不多说,进入正题:个性化自己的注释模板,主要针对Java,其余的语言也是类似的配置方式

第一部分 方法注释配置
步骤一
首先,进入到设置界面:位置:File -> Settings -> Editor -> Live Templates
进入到Live Templates界面之后,点击右上角的加号,新建一个模板组,名称按自己需要,随便取。
文章正文图片
步骤二
新建完模板组后,选择我们新建的组,然后点击右上角的加号,新建动态模板:
文章正文图片
步骤三
模板配置
文章正文图片
解释Abbreviation: 快捷标识:比如我们需要调用这个模板,由于这个值我设置为“*”,所以在使用时只需输入 /**, 然后敲tab键(可配置)即可。

Template text中需要我们输入模板内容,需要注意的是动态内容必须使用$包裹,否则无效。此处我设置的是方法的注释模板,内容如下:
*
 * description  TODO
 * date         $date$ $time$
 * @author      song@devsong.org 
$params$
 * @return      $returns$
 */
由于我们针对的是Java的配置,所以输入模板内容后,点击左下角的Define设置可用的范围,直接勾选Java即可。如图:
文章正文图片
然后点击Edit variables进行参数配置,配置如下:
文章正文图片
params里面由于可能涉及多个参数,所以需要使用groovy脚本来处理,脚本内容如下:
groovyScript("def result=''; def params=\"${_1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split(',').toList(); for(i = 0; i < params.size(); i++) {result+=' * @param       ' + params[i] + ((i < params.size() - 1) ? '\\n' : '')}; return result", methodParameters()) 
其实也就是获取参数列表,遍历输出,复制到上面即可。
其他配置
触发按键:在如下位置设置:
文章正文图片
完成以上配置后就可以进行使用了,效果如下:
文章正文图片

第二部分 类注释配置
完成了上面的方法注释配置,类注释其实是类似的,在上面的组中新建一个模板,配置如下:这里我设置标识为c,所以需要插入该模板的时候,只需输入/*c然后按下tab键即可。(你也可以把完整的注释(包括/*)写入模板,然后使用的时候直接敲出标识符,然后按tab即可)
文章正文图片
文章正文图片
可以根据自己的需求进行调整。
内容如下:
*
 * description  TODO
 * created      $date$ $time$ 
 * class_name   $NAME$
 * @author      song@devsong.org
 * @version     1.0   
 */
使用效果:
文章正文图片


至此,配置完成。可以灵活按照需求进行调整。


20190312 配置更新


(1)方法注释模板
*
 * 
 * $params$
 * @return
 * @date $date$ $time$
 * @author song@devsong.org
 */

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

(2)类注释模板
*
 * 
 * 
 * @author song@devsong.org
 * @version 1.0
 * @date $date$ $time$ 
 * @className $NAME$
 */

It's
欢迎访问本站,欢迎留言、分享、点赞。愿您阅读愉快!
*转载请注明出处,严禁非法转载。
https://www.devsong.org
QQ留言 邮箱留言
头像
引用:
取消回复
提交
涂鸦
涂鸦
热门