0

0

怎么配置IDEA的类头注释模板_File and Code Templates修改

P粉602998670

P粉602998670

发布时间:2026-03-17 13:48:13

|

194人浏览过

|

来源于php中文网

原创

在 File and Code Templates 的 Files 标签页下修改 Class 等模板,使用 ${USER}、${DATE}、${TIME}、${PACKAGE_NAME}、${NAME} 等预定义变量生成类头注释,注意区分 Files 与 Live Templates,避免被插件覆盖。

怎么配置idea的类头注释模板_file and code templates修改

IDEA 类头注释模板在哪改

File and Code Templates 里改,不是在 Live TemplatesEditor > Inspections 里。很多人找错位置,结果改了半天没生效。

路径是:Settings > Editor > File and Code Templates > Files,找到你用的类模板,比如 ClassInterfaceEnum —— 这些才是生成新类时套用的模板。

  • 改的是「新建文件」时自动生成的内容,不是已有文件补注释
  • Includes 标签页里的 File Header 是全局文件头(比如版权说明),它会被插入到每个模板开头,但不替代类模板自身内容
  • 如果用了 Lombok 的 @Data 等注解,模板里别硬写 get/set 方法,容易和实际生成冲突

怎么写带作者/日期的类头注释

IDEA 支持预定义变量,直接填进模板就行,不用手写或脚本拼接。关键是要用对变量名,否则显示成字面量。

常用变量:

  • ${USER}:系统用户名(可手动设为中文名,在 Settings > Appearance & Behavior > System Settings > User name
  • ${DATE}:生成当天日期,格式如 2024/06/12
  • ${TIME}:生成时间,如 15:23
  • ${YEAR}:四位年份
  • ${PACKAGE_NAME}:自动识别当前包路径
  • ${NAME}:新文件名(不含扩展名),也就是类名

示例(粘贴到 Class 模板中):

MidReal AI
MidReal AI

MidReal AI是一款革命性的AI小说生成工具,同时也是一个文本互动冒险游戏平台。

下载
/**
 * @author ${USER}
 * @date ${DATE} ${TIME}
 * @package ${PACKAGE_NAME}
 * @className ${NAME}
 */

为什么改完模板新建类还是没注释

最常见原因是模板没选对,或者被其他插件覆盖。

  • 确认你在改的是 Files 标签页下的 Class,不是 Code 标签页下的任何内容
  • 检查是否勾选了 Enable Live Templates 并误启用了某个同名模板(比如叫 class 的 Live Template),它会劫持新建行为
  • 如果用的是 Kotlin,要改 Kotlin Class 模板,Java 的 Class 模板对它无效
  • 某些公司内部插件(如 Alibaba Java Coding Guidelines)会自带模板逻辑,优先级可能更高,得关掉或调低权重

注释里想加 Git 用户信息怎么办

IDEA 原生不支持 ${GIT_AUTHOR} 这类变量,硬写只会原样输出。真要动态取 Git 配置,得绕路。

  • 可以手动在 Settings > Version Control > Git 里核对 Author nameEmail 是否正确,然后用 ${USER} 代替——前提是本地 Git 用户名和系统用户名一致
  • 不想依赖系统名?只能写死,比如 @author 张三 <zs@example.com>,但失去自动化意义
  • 更灵活的做法是配合 IDE 插件(如 “Template Data Language”),但会引入额外维护成本,小团队不建议

变量不是万能的,${USER} 是最稳的选择;想自动读 Git 配置,就得接受 IDE 不原生支持这个场景。

热门AI工具

更多
DeepSeek
DeepSeek

幻方量化公司旗下的开源大模型平台

豆包大模型
豆包大模型

字节跳动自主研发的一系列大型语言模型

WorkBuddy
WorkBuddy

腾讯云推出的AI原生桌面智能体工作台

腾讯元宝
腾讯元宝

腾讯混元平台推出的AI助手

文心一言
文心一言

文心一言是百度开发的AI聊天机器人,通过对话可以生成各种形式的内容。

讯飞写作
讯飞写作

基于讯飞星火大模型的AI写作工具,可以快速生成新闻稿件、品宣文案、工作总结、心得体会等各种文文稿

即梦AI
即梦AI

一站式AI创作平台,免费AI图片和视频生成。

ChatGPT
ChatGPT

最最强大的AI聊天机器人程序,ChatGPT不单是聊天机器人,还能进行撰写邮件、视频脚本、文案、翻译、代码等任务。

相关专题

更多
Kotlin协程编程与Spring Boot集成实践
Kotlin协程编程与Spring Boot集成实践

本专题围绕 Kotlin 协程机制展开,深入讲解挂起函数、协程作用域、结构化并发与异常处理机制,并结合 Spring Boot 展示协程在后端开发中的实际应用。内容涵盖异步接口设计、数据库调用优化、线程资源管理以及性能调优策略,帮助开发者构建更加简洁高效的 Kotlin 后端服务架构。

156

2026.02.12

class在c语言中的意思
class在c语言中的意思

在C语言中,"class" 是一个关键字,用于定义一个类。想了解更多class的相关内容,可以阅读本专题下面的文章。

951

2024.01.03

python中class的含义
python中class的含义

本专题整合了python中class的相关内容,阅读专题下面的文章了解更多详细内容。

33

2025.12.06

go中interface用法
go中interface用法

本专题整合了go语言中int相关内容,阅读专题下面的文章了解更多详细内容。

78

2025.09.10

自建git服务器
自建git服务器

git服务器是目前流行的分布式版本控制系统之一,可以让多人协同开发同一个项目。本专题为大家提供自建git服务器相关的各种文章、以及下载和课程。

1000

2023.07.05

git和svn的区别
git和svn的区别

git和svn的区别:1、定义不同;2、模型类型不同;3、存储单元不同;4、是否拥有全局版本号;5、内容完整性不同;6、版本库不同;7、克隆目录速度不同;8、分支不同。php中文网为大家带来了git和svn的相关知识、以及相关文章等内容。

582

2023.07.06

git撤销提交的commit
git撤销提交的commit

Git是一个强大的版本控制系统,它提供了很多功能帮助开发人员有效地管理和控制代码的变更,本专题为大家提供git 撤销提交的commit相关的各种文章内容,供大家免费下载体验。

275

2023.07.24

git提交错误怎么撤回
git提交错误怎么撤回

git提交错误撤回的方法:git reset head^:撤回最后一次提交,恢复到提交前状态。git revert head:创建新提交,内容与之前提交相反。git reset :使用提交的 sha-1 哈希撤回指定提交。交互式舞台区:标记要撤回的特定更改,然后提交,排除已撤回更改。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

572

2024.04.09

Python WebSocket实时通信与异步服务开发实践
Python WebSocket实时通信与异步服务开发实践

本专题聚焦 Python 在实时通信场景中的开发实践,系统讲解 WebSocket 协议原理、长连接管理、消息推送机制以及异步服务架构设计。内容包括客户端与服务端通信实现、连接稳定性优化、消息队列集成及高并发处理策略。通过完整案例,帮助开发者构建高效稳定的实时通信系统,适用于聊天应用、实时数据推送等场景。

7

2026.03.18

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号