idea文档注释的快捷键带参数

article/2025/9/21 8:51:53

注意：为了大家能逐步了解对这个小功能有个熟悉的过程（其实是作者比较懒不想从头到尾重新截图 ) 发现问题会在文章未陆续更新建议把整篇文章都看完如果懒得看过程看完开头后文章最后代码直接复制进去就好了

输入 /** 按回车，当然这肯定不是我们想要的答案。
我们想要的应该是这种带模板的
在这里插入图片描述

settings-- editor --Live Templates 右侧点击+ 选择template group新建模板组，再选中刚刚新建的模板组，点击+ 选择live template，

在这里插入图片描述
复制进模板里面：

**
* Description: <br/>
* date: $DATE$ $TIME$<br/>
* @author: your name <br/>
* @since JDK 1.8
*/

如图：

在这里插入图片描述
点击上图 edit variables，expression下拉框选择

最后还有一步：右键选择 change context ，把java勾选上

这里注意一下，如果edit variables是灰色，说明参数写错了，例如eclipse格式： ${DATE} ，而idea是双美元符不用括号

============================================

更新拓展：带参数的注释，效果图以及表达式如下
在这里插入图片描述

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

有的时候某些强迫症的同学（比如我）希望文档注释是 @param xx 而不是@param：xxx ,这两个有什么区别呢带冒号的参数名是绿色不能点击不带冒后后面的参数是黄颜色可以点击当然如果你听不懂我在讲什么说明你没这个强迫症随便复制一段就好了
黄颜色参数可点击：如下图
在这里插入图片描述

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

========================================================
更新：关于@param取不到值的问题：
不能加 / 斜杠(如下图是** 而不是斜杠星星 ) 否则methodParameters()会取不到值！ groovyScript表达式也会为null 这个当时没注意很久都找不到原因!

在这里插入图片描述
另外date()可以自定义 date(“yyyy/MM/dd HH:mm”) 嫌麻烦就用 date time参数去拼接

====== 更新 2021版本 idea 参数对不齐的问题============
最近改成2021版本发现参数换行后会对不齐把这个勾选上就好了当然即使你不是2021也推荐勾上
在这里插入图片描述

====== 更新关于上述注释光标不会默认停在Description的小技巧============
如果按照上面的做法我们会发现光标停留在第一个变量 $DATE$ 上面，造成我们需要手动切换回描述进行注释。
在这里插入图片描述
那么我们可以在Description：后面，随便接上一个变量这样光标就自动在Description后面了（idea2021.1中测试的）

如果觉得上面的比较啰嗦那这儿直接给一个最终版的模板

**
* Description: $context$
* date: $DATE$ $TIME$
$params$
* @author: qkj
* @since JDK 11
*/

在这里插入图片描述
其中params的表达式:

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