IDEA这样配置注释模板,让你的代码瞬间高出一个逼格!

责编：顶级算法 | 来源：Jitwxs 
 链接：jitwxs.cn/4135e0a9.html

上一篇精彩：SpringBoot 全链路透传：MDC + TraceId 最佳实践
 大家好，我是顶级算法。
一、类注释
打开 IDEA 的 Settings，点击 Editor-->File and Code Templates，点击右边 File 选项卡下面的 Class，在其中添加图中红框内的内容：
/** * @author jitwxs * @date ${YEAR}年${MONTH}月${DAY}日 ${TIME} */
在我提供的示例模板中，说明了作者和时间，IDEA 支持的所有的模板参数在下方的 Description 中被列出来。
保存后，当你创建一个新的类的时候就会自动添加类注释。如果你想对接口也生效，同时配置上图中的 Interface 项即可。
二、方法注释
不同于目前网络上互相复制粘贴的方法注释教程，本文将实现以下功能：
根据形参数目自动生成 @param 注解
根据方法是否有返回值智能生成 @Return 注解
相较于类模板，为方法添加注释模板就较为复杂，首先在 Settings 中点击 Editor-->Live Templates。
点击最右边的 +，首先选择 2. Template Group... 来创建一个模板分组：
在弹出的对话框中填写分组名，我这里叫做 userDefine：
然后选中刚刚创建的模板分组 userDefine，然后点击 +，选择 1. Live Template：
此时就会创建了一个空的模板，我们修改该模板的 Abbreviation、Description 和 Template text。需要注意的是，Abbreviation 必须为 *，最后检查下 Expand with 的值是否为 Enter 键。
上图中· Template text 内容如下，请直接复制进去，需要注意首行没有 /，且 \* 是顶格的。
* *  * @author jitwxs * @date $date$ $time$$param$ $return$ */
注意到右下角的 No applicable contexts yet 了吗，这说明此时这个模板还没有指定应用的语言：
点击 Define，在弹框中勾选Java，表示将该模板应用于所有的 Java 类型文件。
还记得我们配置 Template text 时里面包含了类似于 $date$ 这样的参数，此时 IDEA 还不认识这些参数是啥玩意，下面我们对这些参数进行方法映射，让 IDEA 能够明白这些参数的含义。点击 Edit variables 按钮：
为每一个参数设置相对应的 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 类注释
类注释只有在新建类时才会自动生成，效果如下：
3.2 方法注释
将演示以下几种情况：
无形参
单个形参
多个形参
无返回值
有返回值
四、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 时，无法处理退格问题，原因同第三点。

欢迎大家进行观点的探讨和碰撞，各抒己见。如果你有疑问，也可以找我沟通和交流。扩展：接私活儿

为了跟上AI时代我干了一件事儿，我创建了一个知识星球社群：ChartGPT与副业。想带着大家一起探索ChatGPT和新的AI时代。

有很多小伙伴搞不定ChatGPT账号，于是我们决定，凡是这三天之内加入ChatPGT的小伙伴，我们直接送一个正常可用的永久ChatGPT独立账户。

不光是增长速度最快，我们的星球品质也绝对经得起考验，短短一个月时间，我们的课程团队发布了8个专栏、18个副业项目：

简单说下这个星球能给大家提供什么：

1、不断分享如何使用ChatGPT来完成各种任务，让你更高效地使用ChatGPT，以及副业思考、变现思路、创业案例、落地案例分享。

2、分享ChatGPT的使用方法、最新资讯、商业价值。

3、探讨未来关于ChatGPT的机遇，共同成长。

4、帮助大家解决ChatGPT遇到的问题。

5、提供一整年的售后服务，一起搞副业

星球福利：

1、加入星球4天后，就送ChatGPT独立账号。

2、邀请你加入ChatGPT会员交流群。

3、赠送一份完整的ChatGPT手册和66个ChatGPT副业赚钱手册。

其它福利还在筹划中... 不过，我给你大家保证，加入星球后，收获的价值会远远大于今天加入的门票费用 ！

本星球第一期原价399，目前属于试运营，早鸟价139，每超过50人涨价10元，星球马上要来一波大的涨价，如果你还在犹豫，可能最后就要以更高价格加入了。。

早就是优势。建议大家尽早以便宜的价格加入！

排序序列：
1、程序员必知必会的排序一：冒泡排序
2、程序员必知必会的排序二：快速排序
3、程序员必知必会的排序三：直接插入排序
4、程序员必知必会的排序四：希尔排序
5、程序员必知必会的排序五：拓扑排序
6、程序员必知必会的排序六：选择排序
7、程序员必知必会的排序七：归并排序
8、程序员必知必会的排序八：基数排序
9、程序员必知必会的排序九：堆排序

觉得不错？欢迎转发分享给更多人
最近有一些小伙伴，让我帮忙找一些 面试题 资料，于是我翻遍了收藏的 10T 资料后，汇总整理出来，可以说是程序员面试必备！所有资料都整理到网盘了，欢迎下载！
👆扫码回复【面试题】即可获取👆

公众号后台回复 算法 或者 算法心得 有惊喜礼包！

顶级算法交流群

「顶级算法」建立了读者算法交流群，大家可以添加小编微信进行加群。欢迎有想法、乐于分享的朋友们一起交流学习。

扫描添加好友邀你进算法群，加我时注明【姓名+公司+职位】

版权申明：内容来源网络，版权归原作者所有。如有侵权烦请告知，我们会立即删除并表示歉意。谢谢。

往日分享：

如何有效地做算法题？
字节跳动面试经验总结，已顺利拿到offer！
一位大佬用了算法刷题宝典，进阿里了！
牛逼啊，GPT4.0 绘画功能来了！
UUID的弊端以及雪花算法
（此文价值极大）ChatGPT 搞钱来了，抓紧进！！！
SpringBoot API 接口防刷
Spring Boot 分片上传、断点续传、大文件上传、秒传，应有尽有，建议收藏！！
面试官：Redis 缓存满了怎么办？