Idea设置自定义注释模板和代码块

目录

 

前言

注释模板和设置

类注释

方法注释

验证


前言

作为一个合格的开发人员,首先要掌握一款试下主流的开发工具,其实要善用该功能的主要功能,让自己的编码速度和工作效率提升。本文主要介绍基于Idea的注释模板的设置和自定义自主编码快速设置。

注释模板和设置

在Idea中注释可以通过单项设置,也可以通过文件导入,本文主要介绍单项设置。

设置方法:IntelliJ IDEA菜单-->Preferences... --> Editor-->File and Code Templates -->Files-->Class;如下图例;

image.png

打开设置窗口

类注释

类注释模板设置的正确打开方式

image.png

文件头注释设置:如下图,具体模板内容的设置,动态变量可参照Description的说明;

image.png

方法注释

在当前窗口,直接选择Live Templates --> 最右边的+号,选择Template Group,输入自定义名称。

image.png

添加Group之后,就可以添加项;这里测试用到的Group为 Java_test;测试项为x 方法注释模板;

image.png

如上图所示,点击+ 选择Live Template项,在以上红色框部分输入对应的内容。

Abbreviation: 出发模板的关键字

Description:对此模板本身的描述

Template Text: 模板的文本内容;如需要插入动态数据,可以自定义变量,自定义变量定义规则为 $变量名$;注意开头和结尾都是$符号。

Edit variables: 编辑变量,其实主要是对自定义变量进行与系统变量映射,如下图;

image.png

从上图可以发现,在Expression列的下拉框中没有任何可以选择的数据,这是因为没有选择模板的应用上下文环境,需要给与指定,如下图所示,将Java下面的项都选上

image.png

设置之后就能选择

image.png

通过试跑,上配置有个地方设置的有问题,如下图,红框中的斜杠不能有,不然对应变量的参数值不能带出来。

image.png

验证

完成上面的设置之后我们就可以新建一个Java文件类验证了。

在写好的方法上输入 /x就会出现提示,再输入Tab键,就会自动生成注释

image.png

image.png

代码验证,效果如下

/**
 * new-retail-lesson
 * <p>
 *
 * </p>
 *
 * @author Hank
 * @since 2020-10-26
 */
public class IndexCtrl {

   /**
    * 自动注释测试
    * @Params:  [str, number]
    * @Return:  java.lang.String
    * @Throws:  
    **/
    public String hello(String str,Integer number){
        return null;
    }
}

有没发现, 通过上面方法注释的设置,其实也可以设置自定义快速代码块。让自己的编码飞一边的速度,这部分可以自行尝试。


想要了解更多信息,可关注本公众号(一起学开源);或请长按以下二维码添加助手。将拉你加入社区进行更多交流

在这里插入图片描述

©️2020 CSDN 皮肤主题: 精致技术 设计师:CSDN官方博客 返回首页