《IDEA 高效开发：自定义类/方法注释模板详解》

在 IntelliJ IDEA 中，可以通过 Live Templates 和 File Templates 来配置 类注释 和 方法注释 模板，方便快速生成规范的代码注释。以下是详细配置方法：

1. 配置类注释模板（File Header）

作用：在创建新类时自动生成类注释（如作者、日期、描述等）。
配置步骤：

1. 打开设置：
   File → Settings → Editor → File and Code Templates → Includes → File Header
   

2. 输入模板（示例）：

   /**
    * @ClassName ${NAME}
    * @Description ${DESCRIPTION}
    * @Author ${USER}
    * @Date ${DATE} ${TIME}
    * @Version 1.0
    */
   

3. 变量说明：

   • ${NAME}：类名
   • ${USER}：当前系统用户名
   • ${DATE}、${TIME}：当前日期和时间
   • ${DESCRIPTION}：类描述（需手动填写）

4. 应用：创建新类时，IDEA 会自动插入该注释。

2. 配置方法注释模板（Live Templates）

作用：输入快捷键（如 /** + Enter）自动生成方法注释。
配置步骤：

1. 打开设置：
   File → Settings → Editor → Live Templates
   

2. 新建模板组（可选）：

   • 点击 + → Template Group，命名为 MyTemplates。

3. 新建模板：

   • 点击 + → Live Template。

   • Abbreviation（缩写）：输入 /** 或 mc（自定义快捷键）。

   • Template text（模板内容）：

     /**
      * @Description $description$
      * @Param $params$
      * @Return $return$
      * @Author $user$
      * @Date $date$ $time$
      */
     

4. 变量配置：

   • 点击 Edit variables，设置变量值：
     • description：methodName()（或手动填写）
     • params：methodParameters()
     • return：methodReturnType()
     • user：user()
     • date：date()
     • time：time()

5. 适用范围：

   • 勾选 Java → Declaration（确保在方法上生效）。

6. 应用：在方法前输入 /** 并按 Tab 或 Enter，自动生成注释。

3. 示例效果

类注释

/**
 * @ClassName UserService
 * @Description 用户服务类
 * @Author ZhangSan
 * @Date 2023-10-01 14:30
 * @Version 1.0
 */
public class UserService {
    // ...
}

方法注释

/**
 * @Description 根据ID查询用户
 * @Param id 用户ID
 * @Return User 用户对象
 * @Author ZhangSan
 * @Date 2023-10-01 14:35
 */
public User getUserById(Long id) {
    // ...
}

4. 高级配置（可选）

• 自定义日期格式：
  在 File Header 或 Live Templates 中使用 $DATE.format("yyyy-MM-dd")$。
• 公司/项目统一模板：
  通过 Export/Import Settings 导出模板，团队共享。