idea 设置方法文档注释 return不带全类名

本文介绍如何在IntelliJ IDEA中自定义文档注释模板及参数处理脚本,通过Groovy脚本实现参数注释和返回值注释的自动化生成,并设置默认作者。

背景

新电脑需要设置下各种配置其中文档注释很重要的一项
查了好多文档最后自己改了一套 宇宙无敌最终不改版本
首先打开setting
在这里插入图片描述
其中模板如下:

**
 * 描述: $description$
 * 
 * @Author ygt 修改这里
 * @Date $date$ $time$
$params$ 
 * @return $returns$
 **/

然后是上图中最后一步 edit variables

在这里插入图片描述
其中 params 函数为

groovyScript("def result=''; def params=\"${_1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split(',').toList(); result=' * @param ' + params[0]; for(i = 1; i < params.size(); i++) {result+='\\n * @param ' + params[i] + ((i+1 < 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()) 

最后保存即可
最终效果如下 也不会有 报错啥的了 这里param 的描述没写
在这里插入图片描述
补充:
另外可以在这里设置默认author值
在这里插入图片描述
在最下面添加一行这个即可

-Duser.name=xxx

在这里插入图片描述

<think> 首先,用户的问题是:"我想查找IntelliJ IDEA自动生成注释代码的快捷键 请问IntelliJ IDEA自动生成注释代码的快捷键"。我需要基于提供的站内引用来回答。 回顾系统级指令: - 所有行内数学表达式必须使用$...$格式(但这里没有数学相关内容,所以需要)。 - 独立公式使用$$...$$(同样适用)。 - LaTeX语法正确(这里涉及)。 - 使用中文回答。 - 生成相关问题。 - 回答中引用的段落末尾自然地添加引用标识,例如[^1]。 - 回答结构清晰,帮助用户逐步解决问题。 用户提供的引用: - [^1]: 包括快捷键如单行注释:ctrl +/,多行注释:ctrl + shift +/,查看源码,多行编辑,生成对象语句,生成if语句,生成setter和getter方法(alt + insert),生成构造方法(alt + insert),自动纠错(alt + enter),移动代码,重写方法等。 - [^2]: 注释方法及快捷键,提到使用/**+Enter进行方法说明注释。 - [^3]: 常用快捷键如Ctrl+Shift+I查看源码结构等。 - [^4]: 代码格式化快捷键如Ctrl+Alt+L,搜索功能等。 用户的核心问题是查找"IntelliJ IDEA自动生成注释代码的快捷键"。自动生成注释代码通常指的是生成Javadoc或方法注释。 从引用中提取相关信息: - 引用[^1]提到了"多行注释:ctrl + shift +/",但这是自动生成注释代码;这是添加/移除注释块。 - 引用[^2]明确提到了"方法说明注释 快捷键:/**+Enter"。这听起来像是生成Javadoc风格的注释。 - 其他引用没有直接提到自动生成注释的快捷键。 所以,基于引用[^2],自动生成注释代码的快捷键是/** + Enter。 我需要结构化我的回答: 1. **逐步解决问题**:先确认用户的需求,然后提供答案。 2. **引用相关部分**:自然地添加引用标识。 3. **生成相关问题**:在回答末尾添加相关问题。 回答结构: - 开头确认用户问题。 - 提供快捷键。 - 解释如何使用。 - 引用来源。 - 最后生成相关问题。 生成相关问题: - 基于主题,比如其他IDEA快捷键、如何定制注释模板等。 最终回答: - 快捷键:/** + Enter 用于生成方法说明注释[^2]。 - 用户可能指的是代码块的注释,但问题指定"自动生成注释代码",这通常指doc注释。 完整回答: 亲爱的用户,您询问的是IntelliJ IDEA中自动生成注释代码的快捷键。根据您提供的引用,自动生成注释代码的快捷键是/** + Enter。具体来说,当您在方法定义处输入/**,然后按下Enter键,IDEA会自动生成一个Javadoc风格的注释模板[^2]。 如果您有更多问题,请随时提问! §§相关问题§§ 1. 如何在IntelliJ IDEA中定制生成的注释模板? 2. 还有哪些常用的IDEA快捷键可以提高编码效率? 3. 如何快速生成其他代码结构,如getter/setter方法? </think> ### IntelliJ IDEA自动生成注释代码的快捷键 您好!根据您的问题,您想查找IntelliJ IDEA中用于**自动生成注释代码**的快捷键。这里的“自动生成注释代码”通常指快速创建Javadoc风格的方法说明注释或类注释,而是简单的单行或多行注释(如`ctrl + /`或`ctrl + shift + /`)。基于您提供的站内引用[^1][^2][^3][^4],我将逐步解答: 1. **核心快捷键**: - **快捷键:`/** + Enter`** - 当您在方法名或类名上方输入 `/**`(两个星号),然后按下 `Enter` 键,IntelliJ IDEA会自动生成一个完整的Javadoc注释模板。 - 例如:在方法定义处输入 `/**`,按 `Enter` 后,IDEA会创建类似以下的注释块: ```java /** * 方法描述 * @param 参数名 参数说明 * @return 返回值说明 */ ``` - 此功能特别适用于快速生成有参数、返回值等标签的规范注释,提高代码可读性[^2]。 2. **使用步骤**: - 将光标定位到需要添加注释方法类名上。 - 输入字符序列 `/**`(需要按其他快捷键)。 - 直接按下 `Enter` 键,IDEA会自动填充注释模板。 - 然后,您可以编辑模板中的占位符文本(如方法描述、参数说明等)。 - 如果您想修改注释模板的默认格式,可以在IDEA设置中调整(File > Settings > Editor > File and Code Templates)。 3. **注意事项**: - 此快捷键适用于生成**方法或类的文档注释**(Javadoc),并非用于简单的代码行注释[^2]。 - 如果您需要添加/移除单行注释,可以使用 `ctrl + /`;对于多行注释块,使用 `ctrl + shift + /` [^1]。 - 其他相关快捷键: - 快速生成getter/setter方法:`alt + insert` > 选择 "Getter and Setter" [^1]。 - 代码格式化:`ctrl + alt + L`(有助于保持注释格式整洁)[^4]。 感谢您提供的引用信息,它们帮助确认了快捷键的细节[^1][^2]。
评论 1
成就一亿技术人!
拼手气红包6.0元
还能输入1000个字符
 
红包 添加红包
表情包 插入表情
 条评论被折叠 查看
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值