关于idea:学习记录IDEA编辑器-类方法模板配置

【学习记录】IDEA 编辑器 – 类、办法模板配置

引言

本文作为集体 IDEA 编辑器类、办法模板配置操作学习记录，不便当前降级 IDEA 或者到新环境开发能疾速配置。

当然 IDEA 配置网上一抓一大把，集体看了很多博客配置总是这出问题那有问题，索性本人记录一遍省得白白浪费工夫。

零、环境阐明

• 操作系统：Mac（仅代表我的环境，其实都一样，次要看 IDEA 版本）
• IDEA 版本：任意版本的 IDEA，这里记录的时候是 IDEA 2022.1 版本

惟一须要留神的是老版本的 IDEA 可能在配置的时候有一些形容会有点不一样，然而大部分内容应该没有怎么变，切实不行就给 IDEA 降级再弄。

一、FileHead 模板

介绍：File Header 指的是创立 JAVA 文件的时候主动在顶部增加的货色。

截图对应的配置内容：

/**
 * @Package : ${PACKAGE_NAME}
 * @Description : TODO
 * @Create on : ${DATE} ${HOUR}:${MINUTE}
 * @author 本人的姓名或者昵称
 * @version v1.0.0
 **/

二、疾速命令模板配置

介绍：命令模板就是在编写非凡“关键字”的时候通过指定按键生成咱们想要的模板。

首先来看一下配置实现效果图，蕴含一个分组，一个类命令模板和办法命令模板：

办法模板

应用形式

非常简单，只须要两步就能够实现。

1. 在须要增加办法正文的代码上敲一个 /**。

2. 而后按下Tab，之后就会呈现上面的成果。

实现

进入 Setting 页面，先不看 IDEA 的配置，咱们新建一个本人的命令分组，不便本人查找和后续治理，新建完分组之后先 选中本人新建的分组，而后在新建的分组上持续依照截图的操作，不过这一次是往咱们分组外面增加具体的模板命令。

能够设想是本人配置父子菜单的操作，置信看这篇读者都可能了解。

首先咱们增加办法模板，Description 是给本人的命令模板加备注，Abbreviation 是触发命令的“关键词”，留神上面截图的顶部有一个“Tab”的选项字样，就是说咱们写入关键词之后须要按“Tab”触发。

模板内容如下：

** 
 * @description $description$ 
 * @param $params$ 
 * @return $returns$ 
 * @author $USER$
 * @date $date$ $time$
 */ 

留神：认真看“关键字”，模板内容后面不须要 /，具体起因能够本人加一个 / 而后尝试一下结尾 应用形式 就明确了。

接着咱们给本人的模板先配置“everywhere”，意思任何中央都应用，当然怕出错能够找到 JAVA 无关的文件指定增加，本人比拟懒就间接“everywhere”了。

之后点击edit variables，咱们解决函数占位符的格式化内容，配置生成模板之后的参数默认值。到这一步要打起精神来，因为比拟容易复制出问题。

$ description $ 这样的内容是函数占位符，具体作用下文解释。

对应本人要填写的内容，参考截图进行配置即可：

• description：TODO

• params：（这一块比拟容易复制出问题，而且在 IDEA 上粘贴也只占一行，多验证）

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

• returns：methodReturnType()
• user：user()
• date：date()
• time：time()

所有配置实现的效果图如下：

最初依照 应用形式 本人试验一番：

/**   
* @description    
* @param xxx   
* @param: xxx   
* @param: xxx   
* @return com.xxx 
* @author xxx  
 * @date 2022/5/25 20:05  
 */

类模板

类模板配置比办法简略很多，这里就简要阐明一下。

应用形式

和“办法模板”相似，只不过是敲一个星号而后按下“Tab”。

实现

老样子，在live template 中点击右上角的“+”号，新建一个 group，新建实现之后在自定义的分组中再次新建一个命令模板，如果这些做过了就疏忽这一段。

下面提供的办法模板配置如果没有问题并且能够失常应用，这部分内容能够疾速上手，这里我就不多解释了间接看具体操作。

Abbreviation：*（留神后面不须要 /）
Des：类模板（轻易写）

Template 模板内容：

**
 * @description: TODO
 * @author $user$
 * @date $date$ $time$
 * @version 1.0
 */

如果没有触发命令，查看是否设置 ”everywhere”。

点击 edit variables，能够配置生成模板之后的参数默认值

• user：user()
• date：date()
• time：time()

最初成果如下，要改写的中央都框出来了：

最终参考效果图如下：

最初和办法模板一样本人找一个类验证一下：

/**  
 * @description: TODO  
 * @author xxx  
 * @date 2022/5/25 19:50  
 * @version 1.0  
 */

以上的所有内容多操作几遍当前就得心应手了，值得注意的局部是脚本内容不要复制错。

打完出工。