IDEA配置方法注释

爱若执炬迎风

已于 2022-11-07 08:53:12 修改

阅读量1.7w

点赞数 11

文章标签： java

于 2022-03-23 11:05:23 首次发布

美丽善良可爱的WW

本文链接：https://blog.youkuaiyun.com/qq_41908456/article/details/123680740

版权

本文档详细介绍了如何在IntelliJ IDEA中配置类和方法的注释模板。首先，通过File → Settings → Editor → File and Code Templates → Files → Class设置类的注释模板，利用File Header中的参数进行定制。接着，通过File → Settings → Editor → Live Templates创建方法的注释模板，定义Abbreviation、Expand with快捷键以及Template text内容，并在define或change中选择Everywhere → Java应用范围。最后，编辑变量为模板中的参数分配相应的表达式。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

IDEA类和方法注释模板设置（非常详细） - 百度文库

一、设置类的注释模板

1、选择File→Settings→Editor→File and Code Templates→Files→Class。可以看到创建Class时引入了一个参数"File Header.java"。对应的是Files旁边的Includes→File Header文件。

2、File Header里就是创建类时的注释模板，下面Description中有描述一些可以配置的参数，可以根据自己需要选用。

/**
 * @Description //TODO 
 * 
 * @Date ${DATE} ${TIME}
 * @Author wj
 **/

二、设置方法的注释模板

1、选择File→Settings→Editor→Live Templates。点击右边的加号，选择Template Group，创建一个分组。

2、再点击加号，选择Live Template，创建一个模板。其中：

Abbreviation：填模板的缩写，可以使用*号作为代号，方便后面调用模板。

Options→Expand with：填注释模板的扩展快捷键，根据使用习惯，这里使用默认的Tab。

Template text：填写注释模板的内容。参数名使用${参数名}$的格式。（注意：注释模板开头的/不要填写，原因可以看文章末尾的解释）

务必使用图内对应的模板格式

**
 * @Description //TODO 
 * 
 * @Param $param$
 * @return $return$
 * @Date $date$ $time$
 * @Author wj
 **/

3、点击模板页面最下方的警告define，来设置将模板应用于哪些场景，选择Everywhere-->Java即可。（如果曾经修改过，则显示为change而不是define，如上图）

4、然后点击Edit variables，会读取刚刚在注释模板中的配置的参数${参数名}$。在Expression的下拉框中选择方法为其赋值。