精华内容
下载资源
问答
  • 2021最实用的IDEA自定义方法注释和类注释模板,闲话少说,直接上干货 自定义方法注释和类注释 注意:上图中的第四处,Shorten FQ names可以不勾选,它的作用主要就是缩短返回值类型的全类名,比如java.lang.String会...

    闲话少说,直接上干货

    2021/08/21 更新方法注释

    新建类文件的注释配置

    如下 =>
    在这里插入图片描述

    自定义方法注释和类注释

    第一步:在这里插入图片描述

    **
     * $description$
     $params$ 
     $returns$
     * @author xxxxx
     * @date $date$
     */
    

    注意:上图中的第四处,Shorten FQ names可以不勾选,它的作用主要就是缩短返回值类型的全类名,比如java.lang.String会变成String,但是如果是泛型的话会出现一点点小问题。

    第二步:
    在这里插入图片描述

    Groovy脚本

    自定义参数注释

    无参数则默认不生成,expression文本如下:

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

    groovy代码案例如下:

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

    自定义返回值注释

    找了网上很多博客都没有找到满意的,所以干脆自己写了一段Groovy代码,自给自足,哈哈。expression文本如下:

    groovyScript("String params = \"${_1}\";if (params == 'void'){return '* '; };def baseTypes = ['byte', 'short', 'int', 'long', 'float', 'double'];def arrayTypes = ['byte[]', 'short[]', 'int[]', 'long[]', 'float[]', 'double[]'];if (baseTypes.contains(params) || arrayTypes.contains(params)) {return '* @return ' + params; };params = params.replace(' ', '');int index = params.indexOf('<');if (index != -1) {params = params.substring(0, index); };return '* @return {@link ' + params + '}';", methodReturnType())
    

    groovy代码案例如下:

        String customReturnValueAnnotation(String _1) {
            String params = "${_1}";
            // void的情况不需要返回值
            if (params == 'void') {
                return '* ';
            };
            def baseTypes = ['byte', 'short', 'int', 'long', 'float', 'double'];
            def arrayTypes = ['byte[]', 'short[]', 'int[]', 'long[]', 'float[]', 'double[]'];
            // 基本类型不需要引用标识
            if (baseTypes.contains(params) || arrayTypes.contains(params)) {
                return '* @return ' + params;
            };
            params = params.replace(' ', '');
            int index = params.indexOf('<');
            if (index != -1) {
                params = params.substring(0, index);
            };
            return '* @return {@link ' + params + '}';
        }
    

    自定义返回值这做了一些处理,效果见下 :

    • 如果是基本类型的话,就不会被{@link }包裹
      在这里插入图片描述

    • 如果是void的话,就没有return
      在这里插入图片描述

    引用类型则效果如下
    在这里插入图片描述
    在这里插入图片描述

    这样我们可以直接通过Ctrl + 左键跳转到返回值的地方,是不是很棒?

    觉得不错的话别忘了给个赞🤪,谢谢

    展开全文
  • 1、类注释 alt+shift+s 打开设置界面 再inculdes页签中找到 Header....2、方法注释 新建模板组 分别再建两个模板 / 和 * “ / ” 模板内容为: /*** “ * ” 模板内容为 * $method$ * $param$ * @return.

    1、类注释

    alt+shift+s 打开设置界面

    再inculdes页签中找到 Header.java,贴以下模板

    /**
     * ${NAME} 
     *
     * @author ${user}
     * @date ${YEAR}-${MONTH}-${DAY} ${TIME}
     */

     

    2、方法注释

    新建模板组

    分别再建两个模板 / 和 *

    “ / ” 模板内容为: /***

    “ * ” 模板内容为

    * $method$ 
    *        
    * $param$
    * @return $return$
    * @throws Exception
    * @author $user$
    * @date $date$
    */

    注意: 没有注释开头字符 /**

    再点击 Edit Variavbles 编辑参数值

     

    其中 param 的表达式:

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

    如何使用呢?

    在方法上输入 / 然后敲击 两次tab 键,完美解决IDEA方法外,表达式拿不到参数列表问题! 收工!!!

    展开全文
  • 一、自定义方法模板1. File >> Settings… >> Editor >> Live Templates2. 点击创建Group,随意起名3. 创建模板4. 填写模板信息按自己习惯写,我的:** 方法描述* @since: 1.14.1* @param: $...

    一、自定义方法模板

    1. File >> Settings… >> Editor >> Live Templates

    2. 点击创建Group,随意起名

    3. 创建模板

    4. 填写模板信息

    按自己习惯写,我的:

    *

    * 方法描述

    * @since: 1.14.1

    * @param: $params$

    * @return: $returns$

    * @author: zhang

    * @date: $date$

    */

    5. 设置

    设置模板参数自动取值

    直接下拉选择

    点击下方黄色警告区域,勾选java

    二、模板其余配置

    1. 模板快捷键设置

    idea默认模板采用 /**+Enter 生成注释代码块

    自定义模板默认 /* + 你设置的Abbreviation快捷键 + tab

    我的 /**+Enter(Abbreviation直接设置成*)

    2. 参数注释红框

    如图勾选

    3. params带中括号

    略作修改

    *

    * 方法描述

    * @since: 1.14.1

    $params$

    * @return: $returns$

    * @author: zhang

    * @date: $date$

    */

    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) ? '\\n':'')};

    return result", methodParameters())

    4. retrun全类名

    略作修改

    groovyScript("def result='';

    def params=\"${_1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split('

    for(i = 0; i < params.size();

    i++) {if(i!=0){result+='

    def p1=params[i].split(',').toList();

    for(i2 = 0; i2 < p1.size(); i2++)

    { def p2=p1[i2].split('\\\\.').toList();

    result+=p2[p2.size()-1]; if(i2!=p1.size()-1){result+=','}

    } ;

    };

    return result", methodReturnType())

    总结

    到此这篇关于Idea自定义方法注释模板的教程详解(去param括号、return全类名)的文章就介绍到这了,更多相关Idea自定义注释模板内容请搜索我们以前的文章或继续浏览下面的相关文章希望大家以后多多支持我们!

    本文标题: Idea自定义方法注释模板的教程详解(去param括号、return全类名)

    本文地址: http://www.cppcns.com/ruanjian/java/334226.html

    展开全文
  • IDEA 自定义注释方法注释(最可能有效的解决方法) 问题描述: 引言:网上很多这个问题的答案,但都是不完整和没有解释的,因此,自己按网上做的时候发现没有效果,为此,自己总结网上和实践得出有用的解决方法...

    IDEA 自定义类注释、方法注释(最可能有效的解决方法)

    问题描述:

    引言:网上很多这个问题的答案,但都是不完整和没有解释的,因此,自己按网上做的时候发现没有效果,为此,自己总结网上和实践得出有用的解决方法如下:


    解决方案:

    自定义类注释和方法注释的步骤一样,这里只说类注释。


    1、找到如下位置:File -> Settings -> Editor -> Live Templates,如下图
    在这里插入图片描述
    2、先添加一个注释模板组(Template Group),这个组里面可以放多个模板,可以是类注释模板、方法注释模板等等。
    在这里插入图片描述
    3、输入模板组名,模板名随便取,点击“OK”。
    在这里插入图片描述
    4、找到你创建的模板组,然后在模板组下添加模板(Live Template),也就是你要自定义的注释了。
    在这里插入图片描述
    5、输入“模板缩写名”、“模板描述”、“模板内容”。“模板缩写名”就是你要用快捷键来使你自定义的注释出现的时候需要输入的;“模板描述”就是为了让别知道这个模板是干嘛的;“模板内容”就是你自定义的注释内容。
    在这里插入图片描述
    6、如果你需要用到一些特殊值、系统变量,比如当前系统的日期,就需要在“模板内容”里面用两个 $ 把你的变量名包裹起来。然后在“Edit variables”里设置。
    举例:
    下面我的date需要用到系统的日期,而不需要我手写。
    在这里插入图片描述
    在这里插入图片描述
    7、选择我们要用这个模板时需要点击的“快捷键”。
    在这里插入图片描述
    8、⭐⭐(这一步最容易忘记,导致自定义的注释无法使用)选择我们要使用这个模板的上下文,也就是你要在哪些文件里面使用这个模板。
    这里,作者是需要在Java类中用到这个注释,所以直接勾选了“Java”。
    在这里插入图片描述

    9、最后,点击“OK”,那么我们自定义的注释就完成了。
    在这里插入图片描述
    10、开始使用我们自定义的模板。
    在类上空白处,先输入我们刚刚定义的“模板缩写名”,然后按下“Tab”键,那么我们自定义的注释模板就自动出现在我们的类上了,OK完成!!!
    在这里插入图片描述
    在这里插入图片描述

    展开全文
  • 这里写目录标题定义类模板选择class复制上这些代码到右边模板处随便新建一个类,直接触发注释效果,效果如下自定义方法注释模板新建组,组名随便然后再在组名下添加template命名为*把下面这段话复制到这里设置方法...
  • 类生成时候自动加载类注释 模板文件: #if (${PACKAGE_NAME} && ${PACKAGE_NAME} != "")package ${PACKAGE_NAME};#end #parse("File Header.java") /** * <Description> ${NAME}<br> * * @...
  • idea版本:2020.3.x 一、添加类注释模板(新建类自动生成) 1、打开idea,依次如下选择 File–>settings–>Editor–>File and Code Templates–>...二、添加方法注释模板(新建类自动生成) 1、打开idea
  • 一、自定义方法模板1. File >> Settings… >> Editor >> Live Templates2. 点击创建Group,随意起名3. 创建模板4. 填写模板信息按自己习惯写,我的:** 方法描述* @since: 1.14.1* @param: $...
  • IDEA自定义注释模板

    2021-11-01 15:47:15
    1.修改类头的文档注释信息 效果: 步骤: Setting – Editor – File and Code ...2.方法注释模板: 效果: 步骤: 打开file->setting->Editor->LiveTemplates点击右边上面那个+号,选择Template Grou
  • idea方法添加自定义模板注释(带请求参数和返回类型) 网上找了很多方法,有设置脚本的有自定义模板变量替换的,最后都导致请求参数和返回为空,找到一个合适的方法亲测可以。 1.首先在setting -> Editor -> ...
  • IDEA 方法注释 param为null的解决方案

    千次阅读 2021-02-03 10:26:54
    ItelliJ IDEA 自定义方法注解模板 ```c /* * @description 获取证书信息,跳转用 * @author hyj * @date 2021/1/28 17:06 * @param response * @param id * @return CertifiedTemplatePreviewWithAddr */ ...
  • 基于IDEA2020 版本-DEA自定义/修改方法注释和修改类注释.注释时增加时间和作者. 进入设置 修改方法注释 根据如图操作创建一个分类,分类名称我写的是MyAnnotation 完成后得到如下图所示分类 根据上图所示在...
  • 但是选择之后,你在方法中输入/*再tab键时,生成的注释是很奇怪的,多参数的方法名会放在一个数组中,而且返回类型是全限定名,非常长 和我们没有自定义方法注释时候,用idea默认生成的方法注释格式有点不太一样,我...
  • 打开idea 选择 Setting->Editor 依次选择-如图所示: File and Code Templates Includes File Header 添加注释模版 /** * 描述 * * @author ${user} * @date ${YEAR}/${MONTH}/${DAY} ${HOUR}:${MINUTE}:${...
  • 注释(根据自己需求自定义添加) /** @author name @description: ${description} @date ${DATE} ${TIME} @version 1.0 */ 第五步参数(根据自己需求自定义添加) * @author name paramparamparam */ 第六步参数 ...
  • 在Intellij IDEA,默认可以在方法名上方输入 /**+Enter键,自动生成注释块。 系统生成的注释块比较简单,只有@param 和@return 两个参数。 如果想自定义加上其他参数,如作者,日期等,需要做一下配置。 解决...
  • 一、类注释 打开 IDEA 的 Settings,点击 Editor-->File and Code Templates,点击右边 File 选项卡下面的 Class,在其中添加图中红框内的内容: /** * @author jitwxs * @date ${YEAR}年${MONTH}月${DAY}日 ${...
  • 我们在编程中,注释是非常重要的一个环节,IDEA默认的注释只有几个,而且当时团队开发项目时,统一注释格式,是个非常好的约定和习惯。 创建类模板 1. 打开File–>settings–>Editor–>File and Code ...
  • 自定义方法注释模板(类注释设置简单,不做分享),网上搜索类似的文章有很多,但是一味的复制粘贴总会出现各种奇葩问题,最后然并卵!今天特意自己研究琢磨一下,将最终结果分享给大家,100%有效可用!!!首先:IDEA...
  • 2.在方法自定义注释方法上使用快捷键生成,然后手动剪切到方法上面 步骤:首先添加一个自定义模板template group(我这里叫zoomy) 然后选中zoomy, 选择live template 之后,设置快捷.
  • IDEA方法注释获取不到返回值 笔者也找了好多方法,但是一直没有成功,包括设置脚本的,在写方法注释的时候完全没有用,也可能是没有设置对,但是用下边方法是可以成功的。 (1)首先在setting -> Editor -> ...
  • intellj idea的强大之处就不多说了,相信每个用过它的人都会体会到,但是我们经常会感觉他很复杂,尤其刚从eclipse转过来的童鞋,相信刚开始的那段经历都是不堪回首的如何实现类似eclipse的Code Templates那样的功能...
  • idea自定义注释

    2021-03-18 13:56:31
    根据自身需求自定义设置注释模板等信息 编辑函数变量 模板示例 /** * @author reeedking * @date $date$ * @description */ 效果演示 输入class效果 可以直接选择,也可以输入class点击Tab键
  • idea 自定义注释

    2021-10-11 10:32:55
    在项目开发中需要对写的类或方法添加注释,便于后续对代码的阅读和理解,默认的注释不满足的情况下可以自己重新定义注释。 一、打开idea找到File—>Settings—>Editor---->Live Templates 二、建立分组,...
  • IDEA自定义注释

    2021-08-12 13:53:08
    IDEA自定义注释一.自定义类注释1.1打开设置1.2设置模版二.自定义方法注释2.1打开设置2.2创建Template Group2.3创建Live Template2.4设置模版三.效果图 一.自定义类注释 1.1打开设置 preferences->Editor->File...
  • idea自定义注释模板

    2021-05-27 15:42:53
    注释模板设置 1.File-->settings-->Editor-->File and Code Templates-->Files 2.选择Class/Interface文件来设置模板,格式如下: /** *@ClassName ${NAME} *@Description TODO *@Author ...

空空如也

空空如也

1 2 3 4 5 ... 20
收藏数 21,430
精华内容 8,572
关键字:

idea自定义方法注释