IDEA自定义注释模板

问题

以前设置idea liveTemplate 的时候发现注释中的param与return没有成功,当然主要还是自己的原因,所有做简单总结!

解决

1.找到idea实时模板所在的位置:
file ----》settings ----》Editor ----》Live Template

2.新建自己的分组:
选中Template Group,取名为mygroup
选中Template Group,取名为mygroup
3.新建实时模板:
选中Live Template进行创建
在这里插入图片描述
4.贴出以下重点5步骤:
以方法上加注释为例:
在这里插入图片描述
①和②主要取个别名:
Abbreviation:缩写,此处的格式不要在"*me"前面加"/",切记不要用!!!

③主要功能是新建模板的内容:
代码如下:
重点:首个符号不要加"/",以"*"开头,切记,不然不启反应

**
 *@Author $user$
 *@Date $date$ $time$ 
 *$param$
 *$return$
 */

④主要功能:适用于哪种语言,这里指向java:在这里插入图片描述
⑤重中之重的环节,配置param与return:
首先,点击Edit variables,进入如下页面:
在这里插入图片描述
然后先上图片后上代码,位置一一对应~~~
在这里插入图片描述
代码主要分为param与return:(里面的内容可自由修改)
param代码:

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

	return代码:
groovyScript("def returnType = \"${_1}\"; def result = ' * @return : ' + returnType; return result;", methodReturnType())

当然这样看很难看清,赋上js格式打印出来的代码,相信大家一看便知!!!

param方法:

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

return方法:

groovyScript(
	"def returnType = \"${_1}\"; 
	def result = ' * @return : ' + returnType; 
	return result;", methodReturnType()
)

注意:我这里的param是存放一行的,需要换行显示借鉴下面的地址!!!

5.apply、ok之后,至此所有准备工作结束,下面看看效果图:
一定要自己打出来/*,然后tab,其实就是自己打的 / 然后 * 再tab让idea自动补充模板的内容,正好是/**…的内容,然后这样就能获取到params内容了!!!
效果图:
在这里插入图片描述
有什么不对的希望指出,大家一起学习,感谢!!!!!

借鉴此地址:https://blog.csdn.net/Aeve_imp/article/details/85785411

发布了1 篇原创文章 · 获赞 5 · 访问量 71

猜你喜欢

转载自blog.csdn.net/weixin_43834350/article/details/104040003