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

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


1. 配置类注释模板(File Header)

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

  1. 打开设置
    FileSettingsEditorFile and Code TemplatesIncludesFile Header

  2. 输入模板(示例):

    java 复制代码
    /**
     * @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. 打开设置
    FileSettingsEditorLive Templates

  2. 新建模板组(可选):

    • 点击 +Template Group,命名为 MyTemplates
  3. 新建模板

    • 点击 +Live Template

    • Abbreviation(缩写) :输入 /**mc(自定义快捷键)。

    • Template text(模板内容)

      java 复制代码
      /**
       * @Description $description$
       * @Param $params$
       * @Return $return$
       * @Author $user$
       * @Date $date$ $time$
       */
  4. 变量配置

    • 点击 Edit variables,设置变量值:
      • descriptionmethodName()(或手动填写)
      • paramsmethodParameters()
      • returnmethodReturnType()
      • useruser()
      • datedate()
      • timetime()
  5. 适用范围

    • 勾选 JavaDeclaration(确保在方法上生效)。
  6. 应用 :在方法前输入 /** 并按 TabEnter,自动生成注释。


3. 示例效果

类注释

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

方法注释

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

4. 高级配置(可选)

  • 自定义日期格式
    File HeaderLive Templates 中使用 $DATE.format("yyyy-MM-dd")$
  • 公司/项目统一模板
    通过 Export/Import Settings 导出模板,团队共享。
相关推荐
要加油哦~36 分钟前
工具 | 解决 VSCode 中的 Delete CR 问题
ide·vscode·编辑器
fouryears_2341736 分钟前
什么是JSON,如何与Java对象转化
java·spring boot·spring·json
CHEN5_021 小时前
【RocketMQ】一分钟了解RocketMQ
java·rocketmq·java-rocketmq
寒士obj1 小时前
JVM 内存结构
java·开发语言·jvm
带刺的坐椅1 小时前
Solon 整合 LiteFlow 规则引擎:概念与实战
java·solon·liteflow
wuk9982 小时前
互联网应用主流框架整合 Spring Boot开发
java·spring boot·后端
forestsea2 小时前
Caffeine 缓存库的常用功能使用介绍
java·缓存·caffeine
辉辉健身中3 小时前
HttpServletRequest知识点
java
摸鱼仙人~3 小时前
HttpServletRequest深度解析:Java Web开发的核心组件
java·开发语言·前端
nbsaas-boot3 小时前
收银系统优惠功能架构:可扩展设计指南(含可扩展性思路与落地细节)
java·大数据·运维