【idea】idea生产类注释和方法注释
创始人
2024-05-25 16:30:16
0

网上有很多类似的文章,但是我在按照他们的文章设置后,出现了一些问题,因此我这边在解决了问题后,总结一篇文章,发出来给大家借鉴一下。在此先说明一下idea的版本,是2020.1.3

设置动态模板,File->Settings->Editor->Live Template

在这里插入图片描述
点击右上角的+号,添加动态模板组Template Group,再添加动态模板Live Template

在这里插入图片描述
abbreviation意为缩写,如我们设置为testmc。
模板文本template text如下:

** @author your name* @date $date$ $time$* @description $description$* @param $params$* @returns $returns$**/

编辑动态注释要使用的地方
在这里插入图片描述

只选择Java相关的
在这里插入图片描述

点击右侧的edit variables,值的表达式可以使用idea自带的模板,也可以使用groovy表达式
在这里插入图片描述
注意,使用方法注释的方式是 /*+动态模板缩写(testmc)+Tab[2,4]。之前我一直以为直接使用缩写,导致param和return无法识别。这个是使用动态模板后的效果。

在这里插入图片描述

但是在对于方法列表有多个入参的时候,idea自带模板methodParams()不尽如人意,无法对每个参数分别使用一行进行说明,在这里插入图片描述

可以看到param那里还是有一些不尽如人意,我们可以用groovy表达式改进一下。

方法模板改为

** @author your name* @date $date$ $time$* @description $description$$params$$returns$**/

edit vatiables中,param和return值依次如下[1]:
param

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 : result", methodParameters())

return

groovyScript("def returnType = \"${_1}\"; def result ='';if(returnType=='null'||returnType=='void'){return;}else{result += '* @return ';cls = returnType.split('<');for(i = 0; i < cls.size(); i++){temp = cls[i].tokenize('.');result += temp[temp.size() - 1] + ((i < cls.size() - 1) ? '<' : '');};return result + ' ';}", methodReturnType());

在这里插入图片描述
注释效果如下,可以看到对于方法列表有多个入参也能有比较好的效果:
在这里插入图片描述

模板文本这部分设置是你期望的注释格式,诸如$date$是能被idea识别的占位符,在右侧的edit variables中能够编辑这些占位符对应的值。不过在具体的使用中,使用idea自带模板和groovy表达式的时候,模板中是否带有@param@return,是有细微的区别的,这一点读者可以自行验证。

参考文章
[1],IDEA设置方法注释模板
[2],idea设置方法注释(亲测有效)
[3],IDEA设置自定义注释快捷键
[4],超级详细的IDEA设置Java类和方法的注释模板

相关内容

热门资讯

保存时出现了1个错误,导致这篇... 当保存文章时出现错误时,可以通过以下步骤解决问题:查看错误信息:查看错误提示信息可以帮助我们了解具体...
汇川伺服电机位置控制模式参数配... 1. 基本控制参数设置 1)设置位置控制模式   2)绝对值位置线性模...
不能访问光猫的的管理页面 光猫是现代家庭宽带网络的重要组成部分,它可以提供高速稳定的网络连接。但是,有时候我们会遇到不能访问光...
表格中数据未显示 当表格中的数据未显示时,可能是由于以下几个原因导致的:HTML代码问题:检查表格的HTML代码是否正...
本地主机上的图像未显示 问题描述:在本地主机上显示图像时,图像未能正常显示。解决方法:以下是一些可能的解决方法,具体取决于问...
不一致的条件格式 要解决不一致的条件格式问题,可以按照以下步骤进行:确定条件格式的规则:首先,需要明确条件格式的规则是...
表格列调整大小出现问题 问题描述:表格列调整大小出现问题,无法正常调整列宽。解决方法:检查表格的布局方式是否正确。确保表格使...
Android|无法访问或保存... 这个问题可能是由于权限设置不正确导致的。您需要在应用程序清单文件中添加以下代码来请求适当的权限:此外...
【NI Multisim 14...   目录 序言 一、工具栏 🍊1.“标准”工具栏 🍊 2.视图工具...
银河麒麟V10SP1高级服务器... 银河麒麟高级服务器操作系统简介: 银河麒麟高级服务器操作系统V10是针对企业级关键业务...