• IDEA工具第二篇:自定义Java注释模板


    自定义方法注释模板(类注释设置简单,不做分享),网上搜索类似的文章有很多,但是一味的复制粘贴总会出现各种奇葩问题,最后然并卵!今天特意自己研究琢磨一下,将最终结果分享给大家,100%有效可用!!!

    首先:IDEA默认注释

    /**+回车 生成,有些人或许喜欢该种方式,有些人则不太喜欢,因人而异

    不喜欢的人便开始进行自定义如下设置。。。。

    其次:打开IDEA设置选项Settings...(快捷键Ctrl + Alt + S)

    找到 Editor --> Live Templates --> 点击右侧加号 “+

    两种添加都可以,本人以第一种为例,将组名由user变为自己需要的(我的是MyGroup)

    以上6处为需要注意的地方:

    ①Abbreviation:快捷缩略词,可以输入数值、字母、符号,到时配合 /* 使用(依模板内容而定)

    ②Description:实时模板的说明文字,提示显示用

    ③Edit variables:编辑变量按钮,默认灰色不可编辑,只有④中输入了带有 $参数$ 的变量时才会解锁

    ④Template text:模板内容,即自定义注释展示内容

    ⑤Applicable contexts:应用于哪个位置,由于此次操作为Java,固只在Java前挑勾应用

    ⑥Options:其他参数,包括格式化、展开方式等

    然后:设置相应内容

    缩略词我设置的:jmc

    快捷展示我设置的:回车Enter

    模板内容为

    *
    * @description: 一句话描述该方法的作用 $param$
    $return$
    * @author: admin
    * @date: $date$
    */

    第一行默认无缩进一个*号,从第二行开始默认缩进一个空格,其中$param$和$return$前面不加*号(因为在具体的参数方法里面已做处理),和其它非第一行*号保持对齐。此处格式一定要使用这种,因为会配合下面的groovy脚本解析使用。若修改该内容,切记同时修改相应的groovy脚本。

     再然后:设置具体variables

    由于默认的 methodParameters() 生成的多参数在同一行显示,且格式为 [参数名1, 参数名2....] 这种风格,此处进行改造自定义groovy脚本

    param Expression:

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

    展开后逻辑:

    由于默认的  methodReturnType()不返回void类型,此处想设置成无返回值也返回@return void

    return Expression:

    groovyScript("def result=''; def data="${_1}"; def stop=false; if(data==null || data=='null' || data=='' ) { stop=true; }; if(!stop) { result += ' * @return: ' + data; }; return result;", methodReturnType())

    展开后逻辑:


    如果对日期格式有要求的,可以在Expression列中对date()加参,例如date("yyyy/MM/dd")
     

    最后:测试自定义方法注释

    在方法前面输入/*jmc , 然后按回车Enter即可生成

    多个参数且有返回值:

    多个参数无返回值:

    无参数无返回值:

    一个参数无返回值:

     用惯了/**回车,固把缩略词 jmc 改为 *,这样就可以像eclipse一样操作了,嘻嘻^--^!

    完美落幕,如果您觉得有帮助,请点个赞;如果您觉得那个地方有不妥之处,请评论区或者私信我,我会在第一时间尽最大努力解决。

  • 相关阅读:
    vsftpd 启动 vsftpd:500 OOPS: bad bool value in config file for: guest_enable
    Vsftpd服务传输文件(转)
    搭建FTP服务
    sed命令
    创建服务类脚本
    jvm 方法区
    B+与B-树
    适配器模式
    java 垃圾回收总结(可达性分析 引用分类
    HBase常见问题答疑解惑【持续更新中】
  • 原文地址:https://www.cnblogs.com/mharvay/p/12738278.html
Copyright © 2020-2023  润新知