如何高效设置 IDEA 注释模板？一文读懂！

一、类注释模板设置

1. 打开 IDEA 设置
   首先，打开 IDEA 的设置界面，点击 Editor -> File and Code Templates。

   
   

2. 

3. 配置类注释模板
   在右侧的 File 选项卡中，找到 Class，然后添加以下内容：
   java复制

   /**
    * @author 你的名字
    * @date ${YEAR}年${MONTH}月${DAY}日 ${TIME}
    */

   IDEA 会自动识别 ${YEAR}、${MONTH} 等变量，生成当前日期和时间。

   
   

4. 

5. 保存并测试
   保存设置后，新建一个类时，IDEA 会自动生成类注释。

二、方法注释模板设置

1. 打开 Live Templates 设置
   在 IDEA 设置中，点击 Editor -> Live Templates。

   
   

2. 

3. 创建模板分组
   点击右上角的 +，选择 Template Group，创建一个分组，例如命名为 userDefine。

   
   

4. 

5. 添加 Live Template
   在刚刚创建的分组中，点击 +，选择 Live Template，并填写以下内容：

   
   

6. 

• Abbreviation: 输入 *
• Template text: 复制以下内容：
  java复制

  *
   *
   * @author 你的名字 * @date $date$ $time$$param$ $return$ */

• Expand with: 确保选择 Enter 键。
7. 设置适用语言
   点击 Define，勾选 Java，表示该模板适用于所有 Java 文件。

   
   

8. 

9. 配置变量
   点击 Edit variables，为每个变量设置对应的表达式：

   
   

10. 
    

• date 和 time：使用 IDEA 内置函数。
• param：使用以下 Groovy 脚本：
  groovy复制

  groovyScript("def result = '';def params = \"${_1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split(',').toList(); for(i = 0; i < params.size(); i++) {if(params[i] != '')result+='* @param ' + params[i] + ((i < params.size() - 1) ? '\\r\\n ' : '')}; return result == '' ? null : '\\r\\n ' + result", methodParameters())

• return：使用以下 Groovy 脚本：
  groovy复制

  groovyScript("return \"${_1}\" == 'void' ? null : '\\r\\n * @return ' + \"${_1}\"", methodReturnType())

11. 保存设置
    点击 OK 保存，方法注释模板就设置完成了。

三、检验成果

1. 类注释
   新建类时，IDEA 会自动生成类注释，包含作者和日期信息。

   
   

2. 方法注释
   在方法上方输入 * 并按 Enter，IDEA 会自动生成注释，包括形参和返回值。
• 无形参：
  java复制

  /**
   * @author 你的名字
   * @date 2025年03月30日 14:03
   */

• 单个形参：
  java复制

  /**
   * @author 你的名字
   * @date 2025年03月30日 14:03
   * @param name
   */

• 多个形参：
  java复制

  /**
   * @author 你的名字
   * @date 2025年03月30日 14:03
   * @param name
   * @param age
   */

• 有返回值：
  java复制

  /**
   * @author 你的名字
   * @date 2025年03月30日 14:03
   * @return 返回值类型
   */

四、常见问题解答

1. 问：为什么要设置 Abbreviation 为 *？
   答：因为 IDEA 的模板触发逻辑是 模板名 + 生成键，设置为 * 可以方便快捷地触发模板。
2. 问：为什么注释模板中有一行空的 *？
   答：这是为了给方法说明预留一行空白，方便填写方法功能描述。
3. 问：$param$ 和 $time$ 为什么紧贴在一起？
   答：为了避免无参时生成多余的 @param 行，$param$ 需要与前一行内容在同一行。
4. 问：为什么 return 参数不直接使用 methodReturnType()？
   答：因为 methodReturnType() 在无返回值时会返回 void，我们通过脚本优化了这一逻辑。
5. 问：$return$ 为什么不是单独一行？
   答：为了避免在无返回值时生成多余的空行。