IDEA快捷注释生成,类/接口/枚举类/方法注释

快捷注释生成

一、类/接口/枚举类注释

教程

  1. 生成注释模板

    /**
     * @since ${DATE} ${TIME}
     * @author ${USER}
    **/
    
  2. 把模板设置到IDEA中

在这里插入图片描述

原理

此方法是通过修改idea在生成对应文件时使用的模板,来添加注释

${USER}会动态获取当前idea账户的用户名,你也可以自己设置


二、方法注释

教程

  1. 新建一个模板组(User)

在这里插入图片描述

  1. 并在模板组里新建一个实时模板(配置大纲如下)

在这里插入图片描述

配置详情

  1. 如图在缩写填*

  2. 在描述处填写描述,如添加方法模板

  3. 在模板文本处填写

    *
     * $param$
     * @return $return$
     * @since $date$ $time$
     * @author $user$
     */
    
  4. 在展开方式选择自己需要配合缩写的快捷键(建议tab)

  5. 修改适用范围

在这里插入图片描述

  1. 编辑变量

    名称表达式
    paramgroovyScript表达式(如下)
    returnmethodReturnType()
    datedate()
    timetime()
    useruser()
    groovyScript("
    def params=\"${_1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split(',').toList();
    def paramTypes=\"${_2}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split(',').toList();
    if (params[0]!=''){
        def result='\\n';
        for(i = 0; i < params.size(); i++){
            result+=' * @param ' + params[i] + ' [' + paramTypes[i] + '] ' + ((i < params.size() - 1) ? '\\n' : '')
        };
        return result
    }else{
        return null
    }
    ", methodParameters(), methodParameterTypes())
    
  2. 方法注释使用方法:在方法上方输入 /**+tab键

原理

方法注释无非是通过快捷方式生成一个通用的模板的过程

当我们按下缩写*+选择的tab键时,会自动生成模板文本中的内容

*
 * $param$
 * @return $return$
 * @since $date$ $time$
 * @author $user$
 */

因此当我们按下 /**+tab键时,可以分为两步,第一步是/*,第二步则是*+tab键

再合起来就变成了一个完整的注释块,如下

/**
 * $param$
 * @return $return$
 * @since $date$ $time$
 * @author $user$
 */

实时模板再使用我们规定的表达式对以上$xxx$变量进行赋值

$param$参数会通过groovy表达式,匹配和拼接方法参数,你也可以自己编写groovy表达式

我们了解完原理后,就知道了实时模板会在我们选定的范围(java代码中能写注释的地方,上面修改的适用范围)中通过快捷键自动生成模板

因此即使不在方法体上,只要在我们选定的范围中(java代码中能写注释的地方)都可以通过快捷键生成模板

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

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

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

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

IDeLoveYou

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

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

余额充值