IntelliJ IDEA Java注释模板设置详解

3 篇文章 0 订阅
2 篇文章 0 订阅

1. 类型(Types)注释标签(类的注释)

入口:File – Settings – Editor – File and Code Templates – Files – Class

/**
 * @Description 
 * @ClassName ${NAME}
 * @Author User
 * @date ${YEAR}.${MONTH}.${DAY} ${HOUR}:${MINUTE}
 */

效果如下
在这里插入图片描述

2. 方法(Methods)标签

入口:File – Settings – Editor – Live Templates
点击右侧的 + 号,选择Template Group
在这里插入图片描述
在弹出的窗口中随意输入一个名字,例如:MyGroup
在这里插入图片描述
在新增的Group里再新增一个Live Template
在这里插入图片描述
Abbreviation: 随意输入,除了不能输入/*以外,其他都可以随意,在后期调用注释模板的时候会用到
Description:该注释的解释,随意写
Template text:模板
在这里插入图片描述

Template text:

/**
 * @Description 
 * @Param $param$
 * @return $return$
 * @Author User
 * @Date $date$ $time$
 **/

Change按钮点击以后,选择Everywhere
在这里插入图片描述
Edit variables:模板中参数的具体数据
在这里插入图片描述
在这里插入图片描述

param:methodParameters()
return:methodReturnType()
date:date("yyyy.MM.dd")
time:time("HH:mm")
  • 0
    点赞
  • 10
    收藏
    觉得还不错? 一键收藏
  • 1
    评论
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`),即可根据模板快速生成注释

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论 1
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值