IDEA中 快速自定义注释的设置-------类和方法的自定义注释设置

  • 对于新创建的类的“自动”自定义注释:
    打开IDEA(2018.1),选择“file->setting”
    在setting窗口找到editor目录下的“file and code template”。
    在上述窗口右侧中选择“includes”,选定java文件,进行编写即可。
    在下方的Description中有介绍可用的标签,可以借鉴自定义。
    在这里插入图片描述
    这样一旦创建类文件,便可以自动生成类的注释。

  • 对于类的自定义注释。
    File-Setting-Editor-Live Templates
    最右侧点击[+] 选择【Template Group】创建一个模板组,或者选中之前创建的模板组,在最右侧单击『+』号按钮,添加【Live Template】,
    输入模板基础信息(模板名称自定义,我定义为:lei,)点击最下方的applicable 选择java、
    在Template text方框内输入模板内容:

    /**
     *
     * @Description:    $TEXT$
     * @Author:         ZhangHao
     * @CreateDate:     $DATE$ $TIME$
     * @UpdateUser:     Zhangha`在这里插入代码片`o
     * @UpdateDate:     $DATE$ $TIME$
     * @UpdateRemark:   暂无修改
     * @Version:        1.0
    
    */

在这里插入图片描述

注意:可以根据需要设置更多变量,在接下来的步骤中给设置的变量配置相应的取值函数。
在这里插入图片描述
TEXT变量的作用是使注释生成之后,光标自动移到Description后面。

打开Java文件,在Java类上面输入lei后按下回车键即可快速添加类注释模板
在这里插入图片描述

  • 对于方法的自定义注释:
    最开始借鉴https://blog.csdn.net/u014044812/article/details/76577479的方法。
    但是第五步之后就不是很管用了,
    再次借鉴 https://zhuanlan.zhihu.com/p/32891910
    发现他的groovyScript的脚本不完美,故自己更改了脚本代码,代码如下:
groovyScript("def result=''; def params=\"${_1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split(',').toList(); for(i = 0; i < params.size(); i++) {if(i==0){result+='* @param '+ params[i] + '\\t' + ((i < params.size() - 1) ? '\\n' : '')}else{result+=' * @param ' + params[i] + '\\t' + ((i < params.size() - 1) ? '\\n' : '')}}; return result", methodParameters())

使用本脚本便可以完美的展示方法注释了。
我的设置是 /** 之后,按enter展开。默认是Tab展开

【/*】后面跟的是模板的名称(abbreviation),设置模板名为 * 可以延续eclipse的使用习惯。

我发现,如果模板不是 * 的话(比如me),注释只有打在方法内部才会显示具体的params,若打在外部 params会显示null
在这里插入图片描述
所以方法的注释名称最好还是*, 既延续了eclipse使用习惯,又保证方法注释达到效果。

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值