在 IntelliJ IDEA 中设置和使用注释模板

在 IntelliJ IDEA 中设置和使用注释模板可以提高代码规范性和开发效率。以下是详细的设置指南：

📝 设置类注释模板（Class Template）

1. 新建类的注释模板

路径： Settings → Editor → File and Code Templates → Files

Java 类模板示例：

/**
 * @ClassName ${NAME} 
 * @Description TODO
 * @Author ${USER}
 * @Date ${DATE} ${TIME}
 * @Version 1.0
 */
#parse("File Header.java")
#if (${PACKAGE_NAME} && ${PACKAGE_NAME} != "")package ${PACKAGE_NAME};#end

#foreach ($import in $IMPORTS)
import $import;
#end

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

接口模板：

#parse("File Header.java")
#if (${PACKAGE_NAME} && ${PACKAGE_NAME} != "")package ${PACKAGE_NAME};#end

#foreach ($import in $IMPORTS)
import $import;
#end

/**
 * @Interface ${NAME}
 * @Description TODO
 * @Author ${USER}
 * @Date ${DATE} ${TIME}
 * @Version 1.0
 */
public interface ${NAME} {
}

枚举类模板：

#parse("File Header.java")
#if (${PACKAGE_NAME} && ${PACKAGE_NAME} != "")package ${PACKAGE_NAME};#end

#foreach ($import in $IMPORTS)
import $import;
#end

/**
 * @Enum ${NAME}
 * @Description TODO
 * @Author ${USER}
 * @Date ${DATE} ${TIME}
 * @Version 1.0
 */
public enum ${NAME} {
}

---

🔧 设置方法注释模板（Method Template）

2. 实时模板（Live Templates）

路径： Settings → Editor → Live Templates

2.1 添加方法注释

1. 点击右侧 + 号，选择 Template Group，创建组名如 Custom
2. 在 Custom 组下点击 + 号，选择 Live Template
3. 设置如下：

缩写（Abbreviation）: *m
描述（Description）: Add method comment
模板内容（Template text）:

/**
 * @Description: $param$
 * @Param: $params$
 * @return: $return$
 * @Author: $user$
 * @Date: $date$
 */
$END$

定义变量（Define variables）:

点击 Edit variables 按钮，设置：

Name	Expression	Default value	Skip if defined
param	-	TODO	✓
params	groovyScript(“def result=’’; def params="${_1}".replaceAll(‘[\[\]\n]’, ‘’).split(‘, ‘).toList(); for(i = 0; i < params.size(); i++) {result+=‘@param ‘ + params[i] + ((i < params.size() - 1) ? ‘\n * ‘ : ‘’)}; return result”, methodParameters())	-	✓
return	groovyScript(“if("{1}".find(/void/)) return ‘’; else return ‘Object’”, methodReturnType())	-	✓
user	user()	-	✓
date	date()	-	✓

适用语言（Applicable in）: 勾选 Java
缩写上下文（Expand with）: 选择 Tab 或 Enter

---

⌨️ 常用注释模板缩写

3. 实用的 Live Templates

3.1 作者信息注释

缩写: @author

/**
 * @Author xxx
 * @Email xxx@xxx.com
 * @Date $date$
 */

3.2 参数注释

缩写: @param

/**
 * @param $paramName$ $description$
 */
$END$

3.3 返回注释

缩写: @return

/**
 * @return $description$
 */
$END$

3.4 异常注释

缩写: @throws

/**
 * @throws $exceptionType$ $description$
 */
$END$

3.5 待办注释

缩写: @todo

/**
 * @TODO $description$
 */
$END$

---

🎯 使用文件模板（File Templates）

4. 自定义 File Header

路径： Settings → Editor → File and Code Templates → Includes → File Header

/**
 * @ProjectName: ${PROJECT_NAME}
 * @Package: ${PACKAGE_NAME}
 * @ClassName ${NAME}
 * @Description TODO
 * @Author ${USER}
 * @Date ${DATE} ${TIME}
 * @Version 1.0
 */

这样所有新建的文件都会自动包含这个文件头。

---

🔍 可用变量说明

5. 模板中可用的预定义变量

变量	说明
${PROJECT_NAME}	项目名称
${PACKAGE_NAME}	包名
${NAME}	文件/类名
${USER}	当前用户
${DATE}	当前日期
${TIME}	当前时间
${YEAR}	年份
${MONTH}	月份
${DAY}	日期
${HOUR}	小时
${MINUTE}	分钟
${SECOND}	秒
${IMPORTS}	导入的类

---

💡 实际使用示例

6. 完整的 Controller 类模板

#if (${PACKAGE_NAME} && ${PACKAGE_NAME} != "")package ${PACKAGE_NAME};#end

#foreach ($import in $IMPORTS)
import $import;
#end

import org.springframework.web.bind.annotation.*;
import lombok.extern.slf4j.Slf4j;

/**
 * @ClassName ${NAME}
 * @Description TODO
 * @Author ${USER}
 * @Date ${DATE} ${TIME}
 * @Version 1.0
 */
@Slf4j
@RestController
@RequestMapping("/api")
public class ${NAME} {

    /**
     * ${METHOD_NAME}
     * 
     * @param 
     * @return 
     * @author ${USER}
     * @date ${DATE} ${TIME}
     */
    @GetMapping("/test")
    public Result<?> ${METHOD_NAME}() {
        log.info("${METHOD_NAME} called");
        return Result.success();
    }
}

---

🚀 快速使用技巧

7. 快捷操作

1. 生成方法注释：

   • 在方法上方输入 *m 然后按 Tab 键
   • 自动生成带参数和返回值的注释

2. 生成类注释：

   • 新建类时自动包含注释模板
   • 或在类中输入 /* 按两次 /

3. 快速格式化注释：

   • Ctrl + Alt + L 格式化代码
   • Ctrl + Alt + I 优化导入

4. 批量修改注释：

   • Ctrl + Shift + R 全局替换
   • 使用正则表达式匹配注释模式

---

⚙️ 导出和导入模板

8. 备份模板配置

导出：

1. File → Manage IDE Settings → Export Settings
2. 选择要导出的配置项
3. 保存为 .jar 文件

导入：

1. File → Manage IDE Settings → Import Settings
2. 选择之前导出的 .jar 文件
3. 重启 IDEA

---

📌 最佳实践建议

1. ✅ 统一团队规范：将模板配置分享给团队成员
2. ✅ 定期更新：根据项目需求调整模板格式
3. ✅ 保持简洁：注释要精简但信息完整
4. ✅ 版本管理：在注释中包含版本信息
5. ✅ 作者追踪：记录创建者和修改者

这样设置后，您的代码注释将更加规范和高效！🎉