IDEA 注释 修改 模板 @param 设置问题

本文介绍了如何在IntelliJ IDEA中设置自定义的方法注释模板,包括新建模板、编辑模板内容和设置参数变量,以解决@param注释生成时出现多余空行的问题。

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

设置方法注释模板

本文章模板实例样式

**
 *
 *
 * 功能描述 
 * @author hes
 * @date $date$$params$ 
 * @return {@link $return$}
 * 
 */
 

结果示意图

如有疑问,往下看着找~


 

1.首先找到配置注释方法的地方

File-->Settings-->Editor-->Live Templates

 【 + 】号 新建模板

2.新建组,并命名,保存

<think>好的,用户想知道如何在IntelliJ IDEA中配置模板注释中的param参数。首先,我需要回忆一下相关的设置步骤。记得在IDEA中,可以通过Live Templates来设置注释模板,特别是方法注释中的参数部分。 用户提到的引用内容里提到需要创建一个名称为*的模板,并且使用groovyScript来处理参数。这可能涉及到编辑模板变量,尤其是params的设置。需要确保在模板中正确引用methodParameters(),并且用groovy脚本来格式化参数输出。 接下来,应该分步骤说明如何进入设置,选择Live Templates,创建或编辑模板,并配置参数。特别是处理多个参数时,需要换行显示,这可能要用到groovy脚本,如引用3中的例子。同时,还要注意变量表达式是否正确,比如使用$PARAM$还是直接调用methodParameters()函数。 另外,用户可能还关心如何让每个参数单独成行,尤其是在方法有多个参数时。需要详细说明如何填写groovyScript,以及如何测试模板是否生效。可能还需要提醒用户注意模板的名称必须为*,并且以单个星号开头,确保模板能正确应用在方法注释上。 最后,要检查是否有遗漏的步骤,例如设置模板的应用范围(比如Java),或者是否需要勾选“Reformat according to style”等选项。确保用户按照步骤操作后,能够成功生成带有格式化参数的注释。</think>### IntelliJ IDEA 模板注释中`param`参数配置方法 #### 1. 进入Live Templates设置 - 路径:`File → Settings → Editor → Live Templates` - 操作:在右侧窗口点击`+`号选择`Template Group`创建新分组(或使用默认分组) #### 2. 创建注释模板 1. 点击`+`选择`Live Template` 2. **模板名称必须设为`*`**(单个星号) 3. 模板内容格式: ```java * * @description: $description$ * @date: $date$ $time$ * @param: $params$ * @return: $return$ */ ``` #### 3. 关键参数配置(重点) 1. 点击`Edit variables`按钮 2. 为`params`变量绑定groovy脚本: ```groovy groovyScript( "def result=''; def params=\"${_1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split(',').toList(); for(i = 0; i < params.size(); i++) { result += ((i==0) ? '*' : ' * ') + '@param ' + params[i] + ((i < params.size()-1) ? '\\n' : '') }; return result", methodParameters() ) ``` 该脚本实现: - 自动提取方法参数列表 - 每个参数独立成行显示[^3] - 自动去除方括号和空格 #### 4. 设置应用范围 - 点击`Change`按钮 - 勾选`Java → Declaration` #### 5. 使用验证 在方法上方输入`/**`后按`Tab`键,自动生成带格式化参数的注释: ```java /** * @description: * @date: 2023-12-05 14:30 * @param: id 用户ID * @param: name 用户名 * @return: String */ public String getUserInfo(String id, String name) {...} ```
评论 6
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值