Intellij IDEA设置类的文件头注释(@Author)(一)

本文详细介绍了如何在IntelliJ IDEA中设置代码模板,包括三种不同的文件头模板,帮助提高编码效率并保持代码规范。

摘要生成于 C知道 ,由 DeepSeek-R1 满血版支持, 前往体验 >

第一步、File -> Settings
在这里插入图片描述
第二步、Editor -> File and Code Templates -> Includes -> File Header
在这里插入图片描述
提供三个模板供大家使用
模板一:

/**
 * @Author ${USER}
 * @create ${DATE} ${TIME}
 */

模板二:

/**
 * Created by ${USER} on ${DATE}.
 */

模板三:

/**
 * Created by IntelliJ IDEA.
 * User: ${USER}
 * Date: ${DATE}
 */
### 如何在 IntelliJ IDEA 中创建实体时自动生成文件头注释 #### 配置全局模板变量 为了使新创建的 Java 文件能够带有特定的注释,首先需要配置全局模板变量。这可以通过进入 `Preferences` 或者 `Settings` 来完成。 对于 Mac 用户而言,路径为 `IntelliJ IDEA | Preferences...`;而对于 Windows 和 Linux 用户,则应选择 `File | Settings...`。导航至 `Editor | File and Code Templates` 下方找到 `Includes` 并点击左侧列表中的 `File Header`[^1]。 在此处输入希望作为默认文件头的内容,例如版权信息或其他说明文字: ```text /** * @author ${USER} * @date ${DATE} ${TIME} */ ``` 上述代码片段会自动填充当前用户名、日期以及时间到每个新建的 Java 中去。 #### 应用于具体项目 如果仅针对某个特定项目应用此功能而不是整个 IDE 设置的话,在项目的根目录下创建名为 `.ideavimrc` 的隐藏文件并不是正确的方式。相反应该是在该项目内右键单击并选择 `Open Module Settings` (或使用快捷键 `Ctrl+Alt+Shift+S`) 进入模块设置界面之后再做相应调整[^2]。 不过更简便的做法是利用插件来简化这流程,比如安装 "LiveTemplates" 插件可以帮助快速定义和管理各种型的模板,包括但不限于文件头注释。 #### 使用 LiveTemplate 创建个性化模板 通过 `File | Settings/Preferences | Editor | Live Templates` 添加个新的 live template 组,并在里面加入具体的模板条目。设定缩写以便于记忆,如 `fhdr` 表示 file header, 然后编写期望的注释格式: ```text /** * Author : $Author$ * Date : $Date$ */ ``` 记得将适用范围设为 Java Files(`class.java`) 所有地方都可触发该模板。当开始打字匹配所设关键词时就会弹出选项供选取填入预设好的内容了。 #### 自动生成实体的同时添加注解 当从数据库反向工程生成实体时,也可以确保这些包含必要的注释。借助像 MyBatis Generator 或 JPA Buddy 这样的工具可以在生成过程中指定要附加哪些额外的信息给最终产物,从而实现自动化程度更高的开发体验[^3]。
评论 4
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值