Intellij IDEA 这样配置注释模板，让你瞬间高出一个逼格！

分手后的思念是犯贱 2022-10-14 05:42 139阅读 0赞

> 作者：Jitwxs
> 
> 来源：jitwxs.cn/4135e0a9.html

## 一、类注释 ##

打开 IDEA 的 `Settings`，点击 `Editor-->File and Code Templates`，点击右边 `File` 选项卡下面的 `Class`，在其中添加图中红框内的内容：

/**
     * @author jitwxs
     * @date ${YEAR}年${MONTH}月${DAY}日 ${TIME}
     */

![4ed07a5d4508dbf27c643a1d81a60a6c.png][]

在我提供的示例模板中，说明了作者和时间，IDEA 支持的所有的模板参数在下方的 `Description` 中被列出来。

保存后，当你创建一个新的类的时候就会自动添加类注释。如果你想对接口也生效，同时配置上图中的 `Interface` 项即可。

## 二、方法注释 ##

**不同于目前网络上互相复制粘贴的方法注释教程，本文将实现以下功能：**

*  根据形参数目自动生成 `@param` 注解
 *  根据方法是否有返回值智能生成 `@Return` 注解

相较于类模板，为方法添加注释模板就较为复杂，首先在 `Settings` 中点击 `Editor-->Live Templates`。

点击最右边的 `+`，首先选择 `2. Template Group...` 来创建一个模板分组：

![bcb0a63069bcd245e8f57223a1c872ac.png][]

在弹出的对话框中填写分组名，我这里叫做 userDefine：

![b838a90e1268a6c3d67af6714f14af71.png][]

然后选中刚刚创建的模板分组 `userDefine`，然后点击 `+`，选择 `1. Live Template`：

![e3f5774b991f09b50a02beb723189655.png][]

此时就会创建了一个空的模板，我们修改该模板的 `Abbreviation`、`Description` 和 `Template text`。需要注意的是，`Abbreviation` 必须为 `*`，最后检查下 `Expand with` 的值是否为 Enter 键。

![7951f4094770efc928cc9b47414ece47.png][]

上图中· `Template text` 内容如下，请直接复制进去，**需要注意首行没有 `/`，且 `\*` 是顶格的**。

*
     * 
     * @author jitwxs
     * @date $date$ $time$$param$ $return$
     */

注意到右下角的 `No applicable contexts yet` 了吗，这说明此时这个模板还没有指定应用的语言：

![1f9d84113da8317cc7e90282870109cd.png][]

点击 `Define`，在弹框中勾选`Java`，表示将该模板应用于所有的 Java 类型文件。

![78240821aa5803c63a37613854212fc6.png][] 设置 applicable contexts

还记得我们配置 `Template text` 时里面包含了类似于 `$date$` 这样的参数，此时 IDEA 还不认识这些参数是啥玩意，下面我们对这些参数进行方法映射，让 IDEA 能够明白这些参数的含义。点击 `Edit variables` 按钮：

![f5c99e2492f60168ce6813617abe1221.png][]

为每一个参数设置相对应的 `Expression`：

![8e4d45d0e7ccf0aa9ccf6b053b0d9a2d.png][] 设置 Expression

需要注意的是，`date` 和 `time` 的 `Expression` 使用的是 IDEA 内置的函数，直接使用下拉框选择就可以了，而 `param` 这个参数 IDEA 默认的实现很差，因此我们需要手动实现，代码如下：

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

另外 `return` 这个参数我也自己实现了下，代码如下：

groovyScript("return \"${_1}\" == 'void' ? null : '\\r\\n * @return ' + \"${_1}\"", methodReturnType())

> 注：你还注意到我并没有勾选了 `Skip if defined` 属性，它的意思是如果在生成注释时候如果这一项被定义了，那么鼠标光标就会直接跳过它。我并不需要这个功能，因此有被勾选该属性。

点击 OK 保存设置，大功告成！

## 三、检验成果 ##

### 3.1 类注释 ###

类注释只有在**新建类时才会自动生成**，效果如下：

![2cb41122d6aa1fdd3b8320ce6783def0.png][] 类注释

### 3.2 方法注释 ###

将演示以下几种情况：

1.  无形参
2.  单个形参
3.  多个形参
4.  无返回值
5.  有返回值

![d206cc7a60aa8d5025a82a8d17c026bf.png][] 方法注释

## 四、Q & A ##

**（1）为什么模板的 `Abbreviation` 一定要叫 `\*` ？`Expand with` 要保证是 Enter 键？**

答：因为 IDEA 模板的生成逻辑是 `模板名 + 生成键`，当生成键是 Enter 时，我们输入 `* + Enter` 就能够触发模板。

这也同时说明了为什么注释模板首行是一个 `*` 了，因为当我们先输入 `/*`，然后输入 `* + Enter`，触发模板，首行正好拼成了 `/**`，符合 Javadoc 的规范。

**（2）注释模板中为什么有一行空的 `\*`？**

答：因为我习惯在这一行写方法说明，所以就预留了一行空的写，你也可以把它删掉。

**（3）注释模板中 `$time$$param$` 这两个明明不相干的东西为什么紧贴在一起？**

答：首先网上提供的大部分 param 生成函数在无参情况下仍然会生成一行空的 `@param`，因此我对param 函数的代码进行修改，使得在无参情况下不生成 `@param`，但是这就要求 `$param$` 要和别人处在同一行中，不然没法处理退格。

**（4）为什么 return 参数不使用 `methodReturnType()`， 而要自己实现？**

答：`methodReturnType()` 在无返回值的情况下会返回 void，这并没有什么意义，因此我对 methodReturnType() 返回值进行了处理，仅在有返回值时才生成。

**（5）为什么 `$return$` 不是单独一行？**

答：因为当 `methodReturnType()` 返回 null 时，无法处理退格问题，原因同第三点。

--------------------

**微信8.0将好友放开到了一万，小伙伴可以加我大号了，先到先得，再满就真没了**

**扫描下方二维码即可加我微信啦，`2021，抱团取暖，一起牛逼。`**

![bb5d5c30dfca12c813b07cf6fa11c418.png][]

在公众号后台对话框回复关键字：idea获取IDEA教学视频，回复关键字：idea 即可免费领取

我的天! 8年开发，连登陆接口都写这么烂...
    颠覆认知 - MySQL数字类型如何选择？
    厉害了！把 HashMap 剖析的只剩渣了！
    阿里一面：如何保障消息100%投递成功、消息幂等性？
    SpringBoot 中实现跨域的5种方式
    60个相见恨晚的神器工具！
    超级全面的 SpringBoot 注解介绍，每一个用途都应该清晰

**看完本文有收获？请转发分享给更多人**

请长按二维码，关注 Java大数据修炼之道.

**推荐程序员必备公众号 **

**▼**

> **Java大数据修炼之道**
> 
> 公众号：
> 
> gh\_9119f24d3793
> 
> **推荐理由：**
> 
> 在这里，我们分享程序员相关技术，职场生活，行业热点资讯。不定期还会分享IT趣文和趣图。这里属于我们程序员自己的生活，工作和娱乐空间。
> 
>  ▼长按下方↓↓↓二维码识别关注

####  ####

关注 java大数据修炼之道

每天学习java技术你想学的Java知识这里都有**![87c39e36b0a14f8a1f8b2bb911516dc1.png][]**

#### `觉得对你有帮助，喜欢就"在看"呗^_^` ####

![ea7534ec60eecbfaadf45893e6326c96.gif][]

[4ed07a5d4508dbf27c643a1d81a60a6c.png]: /images/20221014/6801c29217db435babdef85ab426aef2.png
[bcb0a63069bcd245e8f57223a1c872ac.png]: /images/20221014/58d1a4b495d94e9597d98419ab9f49b9.png
[b838a90e1268a6c3d67af6714f14af71.png]: /images/20221014/b340e92fb0b84d5b8bbf0fd89ebf6832.png
[e3f5774b991f09b50a02beb723189655.png]: /images/20221014/44282c96706d44a4baf8d7310e0735da.png
[7951f4094770efc928cc9b47414ece47.png]: /images/20221014/4c57bd7c79dc49b2aaf9da9bbc40bbd8.png
[1f9d84113da8317cc7e90282870109cd.png]: /images/20221014/dacf7526a8244972bf44f8dee88a208b.png
[78240821aa5803c63a37613854212fc6.png]: /images/20221014/277836007c9a4bacbc3f518211fefcf9.png
[f5c99e2492f60168ce6813617abe1221.png]: /images/20221014/97dc9bbb90b9471a92bd9e7332a6d60b.png
[8e4d45d0e7ccf0aa9ccf6b053b0d9a2d.png]: /images/20221014/23f7f98fe5f34a1da5ab15367aad54bc.png
[2cb41122d6aa1fdd3b8320ce6783def0.png]: /images/20221014/524371a783344fbbbb6a6c5f0016ffb8.png
[d206cc7a60aa8d5025a82a8d17c026bf.png]: /images/20221014/752c7071b4e2454f87c90a62384889e4.png
[bb5d5c30dfca12c813b07cf6fa11c418.png]: /images/20221014/571c077688214ed7a96fffe3bae2a856.png
[87c39e36b0a14f8a1f8b2bb911516dc1.png]: /images/20221014/5d0fb53b50954550ae2c46eb247b1f23.png
[ea7534ec60eecbfaadf45893e6326c96.gif]: /images/20221014/cc09edabb6db42409de438b7e5db570b.png