IntelliJ IDEA设置类注释和方法注释模板

IntelliJ IDEA设置类注释和方法注释模板

1、设置类注释模板

这里写图片描述
这样在定义类时,都要多输入类的描述。不想的话,可以删去 ${description}

2、方法注释模板

先新建模板组,名字自己起。

这里写图片描述

然后选中自己的模板组,在模板组下新建模板

这里写图片描述

如下图给模板设置信息

这里写图片描述

1、设置模板名称,建议不要换,就是 * 号

2、模板描述,可以没有

3、模板,注意开头是没有 /* 的

*
 *功能描述 
 * @author qqg
 * @date $date$
 * @param $params$ 
 * @return $return$
 */
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7

4、添加模板生成的地方,点开选择java或者全部都可以

5、设置模板快捷键,我设置为回车

6、编辑模板中的参数

这里写图片描述

7、点apply完成

8、用法:跟原来的一样: /** + 回车 即可,这就是我为什么取名为 * 的好处。

4、细节修改

可以看到生成模板的参数时,不是很好,是数组的,要做一下修改

1、模板改为:

*
 *功能描述 
 * @author qqg
 * @date $date$
 $params$ 
 * @return $return$
 */
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7

2、添加 $params$ 参数分割

这里写图片描述
即:

groovyScript("def result=''; def params=\"${_1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split(',').toList(); for(i = 0; i < params.size(); i++) {result+=' * @param ' + params[i] + ((i < params.size() - 1) ? '\\n':'')}; return result", methodParameters())
  • 1

转载自:https://blog.csdn.net/qinqigang/article/details/79071486



  • 42
    点赞
  • 109
    收藏
    觉得还不错? 一键收藏
  • 16
    评论
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`),即可根据模板快速生成注释
评论 16
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值