IDEA设置自定义注释（已亲测），新创建类的注释，在方法上自定义注释，设置注释签名

文章目录

- - - [一、设置类注释（文件头注释）](#一、设置类注释（文件头注释）)
    - [二、设置方法注释](#二、设置方法注释)
    - [三、其他相关设置](#三、其他相关设置)
    - 四、作者实操截图
    - - 1、新建文件自定义注释（签名）
      - 2、在方法上设置自定义注释（签名）
    - 参考文档

一、设置类注释（文件头注释）

类注释通常用于描述整个源文件的基本信息。

打开设置：
- 点击顶部菜单栏 File -> Settings (Windows/Linux) 或 IntelliJ IDEA -> Preferences (macOS)。
- 在设置窗口中，依次展开 Editor -> File and Code Templates -> Includes。
- 找到 File Header (对于Java文件) 或其他对应语言的文件头模板项。
编辑模板：
- 在右侧的文本框中，可以编辑文件头注释的模板。例如：
  java 复制代码
```
/**
 * @author YourName
 * @date ${DATE} ${TIME}
 * @description TODO
 */
```
- 模板变量说明 ：
  - ${DATE}: 自动生成当前日期 (例如: 2026-04-09)。
  - ${TIME}: 自动生成当前时间 (例如: 21:08)。
  - ${USER}: 自动生成当前操作系统用户名。
  - ${YEAR}, ${MONTH}, ${DAY}, ${HOUR}, ${MINUTE}: 更精确的时间组件。
  - ${PACKAGE_NAME}: 自动生成所在包名。
  - ${NAME}: 自动生成文件名 (常用于类注释)。
- 你可以根据团队规范自定义内容和格式。
应用并保存：
- 点击 Apply 或 OK 按钮保存设置。之后，当你创建新的 .java 文件时，该头部注释就会自动添加到文件顶部。

二、设置方法注释

方法注释用于描述函数的功能、参数、返回值等信息。

打开设置：
- 仍然在 Settings / Preferences 中，这次选择 Editor -> Live Templates。
创建或修改模板组：
- 为了方便管理，可以创建一个新的模板组。点击右侧的 + 号，选择 Template Group...，输入一个名称（如 CustomMethodComment）。
创建方法注释模板：
- 在你新建的组里，再次点击 + 号，选择 Live Template。
- Abbreviation : 输入触发此注释的快捷键，例如 * 或 /** (注意：/** 是默认的 JavaDoc 注释触发键，你可以自定义其他键)。
- Description: 输入描述，比如 "Custom Method Comment"。
- Template text : 输入你的方法注释模板。一个常用的 Groovy 脚本模板如下，它能自动解析方法签名并填充参数名：
  java 复制代码
```
/**
 * @description:
 * @author: $user$
 * @date: $date$ $time$
 * @param: $params$
 * @return: $return$
 */
```
- Define : 点击下方的 Define，勾选适用的语言（如 Java），并可以选择仅在特定上下文（如 Method）中可用。
配置变量（Edit Variables）：
- 点击 Edit variables 按钮。对于上面模板中的 $params$ ，你需要为其设置 Expression (表达式) 来自动获取参数列表。可以使用 groovyScript() 函数，例如：
  groovy 复制代码
```
groovyScript("def result = ''; def method = _1; def params = method.getParameterList().getParameters(); for (int i = 0; i < params.length; i++) { result += params[i].getName() + ' '; } return result;", method)
```
  - _1, _2, _3... 对应下方 Ordinal 列表中的变量顺序（method 通常是第一个）。
  - 类似地，你可以为 $return$ 设置表达式来获取返回类型，例如 method.returnType.presentableText。
  - 为 $user$ 和 $date$ , $time$ 设置默认值，如 userName() 和 date(), time()。
应用并保存：
- 点击 Apply 或 OK 保存所有设置。
使用方法注释：
- 在一个方法的上方（不是内部），输入你设置的快捷键（例如 /**），然后按 Enter 或 Tab 键，IDEA 就会自动生成带有参数和返回值占位符的注释块。

三、其他相关设置

自定义 TODO 标记 ：在 Settings / Preferences -> Editor -> TODO 中，可以添加自定义的标记（如 @note, @fixme），并设置它们的高亮颜色和优先级，方便在 TODO 工具窗口中追踪。
修改注释颜色 ：在 Settings / Preferences -> Editor -> Color Scheme -> Language Defaults -> Comments 中，可以调整代码注释的字体颜色和背景色。

四、作者实操截图

1、新建文件自定义注释（签名）

java 复制代码

/**
 * $END$
 * </br>
 $param$
 $return$
 * @author $user$
 * @date $date$
 * @desc
*/

作者使用的

txt 复制代码

/**
 * @author ${USER}
 * @date ${DATE} ${TIME}
 * @desc
*/

2、在方法上设置自定义注释（签名）

java 复制代码

/** 
 * @describe:
 * @param: $params$
 * @return: $returns$
 * @author: dingws
 * @version: 1.0.0
 * @date $date$ $time$
 **/

IDEA设置自定义注释（已亲测），新创建类的注释，在方法上自定义注释，设置注释签名

文章目录

一、 设置类注释（文件头注释）

二、 设置方法注释

三、 其他相关设置

四、作者实操截图

1、新建文件自定义注释（签名）

2、在方法上设置自定义注释（签名）

参考文档

一、设置类注释（文件头注释）

二、设置方法注释

三、其他相关设置