idea类和方法配置注释模板

很多开源的代码,人家注释写的那叫个工整啊,一直知道idea可以配置各种模板,但是觉得简单一直没去弄;今天看了些博客配置,发现自己按照上面来配还是没有达到自己想要的要求,改动调整后才达到;

我们要自己定义方法注释的模板,在Live Templates添加即可,但是我们要改默认的类上模板则需要File and Code TemplatesFile Header中增加配置,这样在类创建时就会按我们配置的生成注释;

/**
 * @description: TODO
 * @author: ${USER}
 * @date: ${DATE}
 */

preferences–>Live Templates 点击右侧加号添加模板组,以我这里的配置为例,我自定义为definedTemplates

分别定义了类上注释和方法上的注释模板;

类模板(注意:第一个*号要最左,不是写错!)

*
 * @description: TODO
 * @auther: $user$
 * @date: $date$
 */

方法模板

*
 * @description: TODO
 * @author: $user$
 * @date: $date$
 $params$
 * @return: $return$
 */

p a r a m s params params参数对应配置:

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) ? '\\r\\n ' : '')}; return result", methodParameters())


配置完,使他在java的配置中生效

注意📢 :我们配置的类名和方法名的缩写分别是*c,*f

那么我们在类上添加注释的方式就是输入/**+c和enter键,在方法上添加注释的方式是输入/**+f和enter键;

其实我们在File and Code TemplatesFile Header中增加了类的注释模板,类在创建时就如同我们/**+c和enter的效果一致,但很多时候我们用一些工具生成或者拷贝别人代码的时候,并不会重新创建类,当我们需要修改时就可以用到这个快捷键了;

效果如下,很多注释属性觉得没用,只保留了个人认为重要的一些注释:
gqIYxe.png

小结:本篇简要的介绍了类及方法上配置注释模板的方法,快配置完舒服一波吧;

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

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论 1
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值