IDEA中关于自定义注释设置总结(可获取方法参数)

最近在写代码时候,每次都要手动敲方法注释,太磨人了,而且自定义注释模板,发现无法显示方法参数的效果,经过一番捣鼓之后,终于达到自己想要的结果,这里总结自己的设置方法,供大家参考。

一、首先进入设置参数模板页面

路径:settings/Code Style/Live Templates,具体操作如下图所示。

现在对其中3/5/6/7等步骤解释一下。

第三步:因为最后使用的方式为/**+TAB按键来生成,所以模板的快捷键需要设成*

第六步:我的模板内容如下:

*
 * <p></p>
 *
 $param$
 * @return $return$
 * @author $user$ $date$ $time$
 */

这里需要把前面的/*的删除,而且由于后面使用了脚本的方式来寻找方法参数,所以$param$的位置也要进行微调,来适配最终的效果。

第六步:这个比较简单,我只设置了适配java文件。

第七步:这一步比较关键,先说设置吧,如下图所示。

这里,关键点主要是param和date,其他用的都是idea提供的方法。

param使用了脚本来进行获取,方法参数的值,脚本如下:

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

然后,个人比较喜欢2019年5月22日这种格式,所以在date()方法里面定义了一下显示格式,默认的是2019/5/22。

总而言之,这样设置就可以了,置于为什么要这么写,个人觉得不用太纠结,只要能用就好了,毕竟是辅助编码而已。最终效果图如下所示。

  • 1
    点赞
  • 1
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值