IDEA 设置类、方法注释模板(图文教程)

更新时间 2022-11-05 21:24:14

一则或许对你有用的小广告

欢迎加入小哈的星球 ,你将获得:专属的项目实战 / Java 学习路线 / 1v1 提问 / 学习打卡 / 每月赠书活动

目前, 星球 内第2个项目《仿小红书(微服务架构)》正在更新中。第1个项目:全栈前后端分离博客项目2期已经完结,演示地址:http://116.62.199.48/。采用技术栈 Spring Boot + Mybatis Plus + Vue 3.x + Vite 4手把手,前端 + 后端全栈开发,从 0 到 1 讲解每个功能点开发步骤,1v1 答疑,陪伴式直到项目上线,目前已更新了 288 小节,累计 45w+ 字,讲解图:2012 张,还在持续爆肝中,后续还会上新更多项目,目标是将 Java 领域典型的项目都整上,如秒杀系统、在线商城、IM 即时通讯、权限管理等等,已有 1600+ 小伙伴加入,欢迎点击围观

大家好,我是小哈~

前言

IDEA 默认的注释模板生成的注释信息不够详细,针对方法,比较通用的注释内容大概如下:

类注释

类注释效果图:

类注释类注释

  • Author : 类创建作者;
  • Date : 类创建日期;
  • Version : 版本号;
  • Description: 类描述信息;

方法注释

方法注释效果图:

方法注释效果图方法注释效果图

设置类注释模板

点击菜单 File -> Settings -> Editor -> File and Code Templates , 在 Files 中找到 Class 模板, 模板头中可以看到引入了一个名为 Header.java 文件:

注释模板引入了 Header.java注释模板引入了 Header.java

Header.javaIncludes 中可以找到它:

定义类注释格式定义类注释格式

在右边输入框中输入注释模板,格式如下:

/**
  *@Author: 犬小哈
  *@Date: ${DATE} ${TIME}
  *@Version: v1.0.0
  *@Description: TODO
 **/

TIP: 这里的 @Author 作者我写死了我的名字,还可以定义成 ${USER}, 如下面这样:

/**
  *@Author: ${USER}
  *@Date: ${DATE} ${TIME}
  *@Version: v1.0.0
  *@Description: TODO
 **/

这样,就可以动态获取系统当前用户名了。

设置完成后,点击 Apply 应用,然后点击 OK 关闭弹框。

试试效果

接下来,我们新建一个类,就可以看到注释模板已经生效了:

类注释类注释

设置方法注释模板

IDEA 中没有直接设置方法注释模板的地方,但可以借助 Live Templates 来实现,步骤如下:

1、点击菜单 File -> Settings -> Live Templates, 点击右侧的加号新建 Template Group ... 模板组, 将其命名为 myGroup :

IDEA 添加 Template GroupIDEA 添加 Template Group

新建完成模板组后,继续点击右边的加号新建方法模板 Live Template :

新建方法模板 Live Template新建方法模板 Live Template

这里小哈设置注释缩写 (Abbreviation) 为 /** , Expand with Enter 表示通过敲击回车生成方法注释

设置方法注释模板设置方法注释模板

复制粘贴下面的注释模板到 Template text 输入框中:

/**
 * @Auther: 犬小哈
 * @Date: $date$ $time$
 * @Description: TODO
 */

在输入框的下方,你会看到如下这样的警告:

设置方法注释模板的应用范围设置方法注释模板的应用范围

它表示还未给刚刚添加的方法注释模板设置应用范围,选择 Everywhere 表示任何位置均可添加该注释,设置完成后,如下所示:

设置方法注释模板的应用范围为 Everywhere设置方法注释模板的应用范围为 Everywhere

一切设置完成后,点击 Apply 应用设置,然后点击 OK关闭弹框。

如何生成方法注释?

比如,想要在下面这个新建的方法上生成注释,首先,第一步在方法的上一行输入 /**:

开始生成方法注释开始生成方法注释

敲击回车,即可生成注释

生成方法注释成功生成方法注释成功