在idea中设置java方法自定义注释

本文详细介绍了如何在IntelliJ IDEA中自定义方法注释模板。从打开设置界面,新建模板组,到设置模板内容,定义快捷键,以及编辑变量表达式,特别是使用Groovy脚本来格式化参数和返回类型。最后,调整注释格式并进行代码格式化,确保注释符合个人习惯。
摘要由CSDN通过智能技术生成

首先通过Ctrl+Shift+A调出命令窗口,输入settings,回车快速进入settings界面

 然后找到live template,找到右边的加号,新增一个代码模板

 选择第二个,template group

 输入组名,确认

 然后点击刚创建的group,继续选择右边的加号,选择第一个选型live template

abbreviation处填写*  ,后边description是描述信息,根据自己的需要填写,expand with,后边是调用快捷键,我选择的是tab键

 最主要的是下边的template text

*
 * @description: 
 * @author: 你的名字 
 * @date: $date$
 $params$
 * @return: $return$
 **/

可以看到最下边还有一行红色的警告信息,是应该用上下文没有定义,点击define

然后选择应用的范围是java

 

最后一步最关键,就是设置模板参数变量的表达式了

选择edit variables,编辑变量

 

其中$date$参数的表达式,可以从expression下拉列表中选择date()函数使用就行了

如果继续往下拉,可以看到也有一个methodParameters()函数和methodReturnType()

 可以选择这两个对应的函数,但是选择之后,你在方法中输入/*再tab键时,生成的注释是很奇怪的,多参数的方法名会放在一个数组中,而且返回类型是全限定名,非常长

和我们没有自定义方法注释时候,用idea默认生成的方法注释格式有点不太一样,我个人还是感觉很别扭的

所以需要修改一下

 

就是params和return的表达式不要用内置的函数,要写一个groovy脚本

params的脚本为:

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

 return的脚本为:

groovyScript("def result=''; def params=\"${_1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split('<').toList(); for(i = 0; i < params.size(); i++) {if(i!=0){result+='<';};  def p1=params[i].split(',').toList();  for(i2 = 0; i2 < p1.size(); i2++) { def p2=p1[i2].split('\\\\.').toList();  result+=p2[p2.size()-1]; if(i2!=p1.size()-1){result+=','}  } ;  };  return result", methodReturnType())

然后再试一下,/**加tab键格式就正常了

如果格式稍微有错位,选中注释,Ctrl+Alt+L,格式化一下就好了 

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值