IDEA中如何自定义注释模板

967 阅读1分钟

小知识,大挑战!本文正在参与“程序员必备小知识”创作活动。

背景

在我们日常开发中,都会存在很多加入注释的地方,比如类、再比如方法,甚至参数名,返回结果。

但是这个时候呢,我们就可以使用IDEA中的自定义注释模板来初始化注释了。

就比如:

  /**  
    * @description: TODO
    * @author ${USER}
    * @date ${DATE}${TIME}
    */

这样的注释模板既可以适用于修饰类,也可以用来修饰方法。

下面就来看一下如何设置吧。

知识点

首先我们来打开File————>Setting--->Editor--->Filr and Code Templates--->Includes--->File Header。

还是来一张图更方便看,上图!

image.png

在这里其实有着很多文件的类型,如HTML、Class、interface、css等等,每个类型都有自己的模板。

这里如果没有太理解的话,也可以这么理解,当我们创建一个文件时,通常会初始化出一些信息来,比如创建类时,会自动生成pulic class 类名{},当然了还有包名之类的。

今天我们来说一下Class中的模板定义。

在Class类型中,就可以指定我们文中一开始的注释了。

image.png

如上图,再解释一下这几个注解参数的含义吧。

@description: 方法描述信息
@author 创建者,
${user}是当前计算机的用户名
@date 时间点
${DATE}:日期,如2021-09-09
${TIME}:时间,如12:00:01

每天记录一下自己上班需要百度的问题,永远相信美好的事情即将发生。