记一次IDEA 方法注释模板的经验

[北海以北]

于 2021-11-24 11:04:38 发布

阅读量362

点赞数 2

CC 4.0 BY-SA版权

本文链接：https://blog.youkuaiyun.com/weixin_44530087/article/details/121510843

笔记专栏收录该内容

14 篇文章

订阅专栏

本文详细介绍了如何在IntelliJ IDEA中配置方法注释模板，解决参数显示问题，提供了一步一步的设置步骤和关键代码片段，助你快速创建专业级的注释模板。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

IDEA方法注释模板

IDEA的方法注释设置起来，相较于类注释模板较为繁琐，网上搜了很多，都是卡在注释的多个参数不显示，或者显示param为null，所以这次就只记录下我配置方法注释模板的经验

1.File – Settings

在这里插入图片描述

2.进入方法模板，先建组

Live Templates-- Template Group
在这里插入图片描述

3.设置触发方法的“快捷键”–Abbreviation

在这里，我设置的是一个* ，在右下方点击Edit variables设置参数，触发按钮Expand with 设置的是回车键

在这里插入图片描述

params参数内容（网上搜了很多，这个能正常显示）

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

然后将下方的模板复制进Template text中，之后使用 “ /**” + “回车” 即可使用此方法模板

*
 * @Description:
 * $params$
 * @return: $return$
 * @author: XXX
 * @date: $date$ $time$
 */

4.设置成功后，在方法上使用 “/**” + “Enter” ，显示如下：

$[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-qb1MgLFT-1637722762166)(C:\Users\徐露露\Desktop\IDEA方法注释模板\例子.png)]$