intellij idea 注释模板

简介

IntelliJ IDEA 注释模板自定义的方式有多种,下面介绍如Live Templates 和File and Code Templates。

文件模板设置

文件模板在创建对应文件时自动包含在文件中,例如,Java 注释:

选择菜单栏 File -> Settings -> Editor -> File and Code Templates -> Includes > File Header

/**
 *
 * @author YourName
 * @version 0.0.1
 * @since ${DAY} ${MONTH_NAME_SHORT} ${YEAR}, ${TIME}
 */

如下图所示:

在这里插入图片描述
上图中的 ${DAY} 表示月的天,会根据当期日期自动生成,具体含义在下面的 “Description” 窗口有解释。

注释位置设置

如果有需求,可以设置注释在文件中的位置,例如对 Java 类,“File Header” 放在类声明前面:

在这里插入图片描述
满足我的需求,就不更改了。

动态模板

如下图所示:

在这里插入图片描述

这是和上面注释一样的动态模板。

缩写 “cm”,表示在 Java 中输入 cm 会自动弹出该注释。

其中变量以 $var$ 定义,然后点击 “Edit variables” 输入具体变量的含义:

在这里插入图片描述
下面的 “Applicable in Java: comment” 表示应该该动态模板的范围,这里对应 Java 注释。

参考

  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
IntelliJ IDEA 是一款强大的 Java 开发集成环境,它提供了丰富的代码自动生成和模板设置功能,其注释模板是帮助开发者快速生成常见注释的一种便捷方式。以下是设置注释模板的基本步骤: 1. **打开注释模板设置**: 在 IntelliJ IDEA ,点击 "File"(在 macOS 上是 "IntelliJ IDEA" 或者 "Code"),然后选择 "Settings"(Windows 和 Linux)或 "Preferences"(macOS)。 2. **导航至 "Code Style"**: 在设置窗口,找到并展开 "Editor" > "Code Style" > "Java"。 3. **选择 "Live Templates"**: 在 Java 配置区域,你会看到 "Live Templates",这是管理模板的地方。 4. **创建或编辑模板**: 右键点击 "Code" 或 "Comment" 栏目下的空白区域,选择 "Edit" 来添加新的注释模板。例如,你可以为 Javadoc 注释创建一个模板,键入 `javadoc` 作为前缀,然后输入你的模板内容,比如: ``` /** * ${cursor}${description} * * @param ${param} 参数描述 * @return 返回值描述 * @throws ${exception} 可能抛出的异常 */ ``` 这里 `${cursor}` 表示光标插入的位置,`${description}`、`${param}` 和 `${exception}` 是占位符,会在输入时自动替换为你指定的内容。 5. **保存模板**: 完成模板配置后,记得点击 "OK" 保存你的更改。 6. **使用模板**: 在编写代码时,只需输入模板前缀(如 `javadoc`),然后按相应的快捷键(通常是 `Ctrl + Alt + T` 或者 `Cmd + Alt + T`),即可根据模板快速生成注释。
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值