idea在方法自定义注释和解决自定义参数获取不到问题

直接上图,展示效果
最终效果达到
1.自定义注释方法步骤:按照下面的方法设置即可
第一步,选择File -> setting
在这里插入图片描述
第二步,选择Editor -> Live Templates
在这里插入图片描述
第三步,点击 + 号 -> 选择第二项Template Group, 至于By default expand with那里可以根据自己习惯,选择Enter或者Tab,他们区别在于,在方法生成注释时,按回车还是Tab(假设选择Enter时,在方法生成注释操作为 /* + 模板名,然后按键盘回车键,同理设置Tab,则是按键盘Tab键)
在这里插入图片描述
第四步,选择Template Group后,在弹窗中输入自己定义的模板名
在这里插入图片描述
第五步, 选中刚新增的模板,点击‘+’,选择第一个(Live Template)在这里插入图片描述
第六步,点击上述步骤后,会展示如下图,
在这里插入图片描述
注释复制可以直接用

*
 * 功能描述: 
 *
$param$
 *
 * @return $return$
 * @auther $user$
 * @date $date$ $time$
 */

第七步,点击上图Define,
在这里插入图片描述
在这里插入图片描述
第八步,点击下图中Edit variables
在这里插入图片描述
点击后,弹出窗口,按如下选择return、user、date等相关参数(点Expression中单元格,出现下拉选), param不要使用idea提供的
在这里插入图片描述

第九步,这里也是最重要的一步,网上很多设置,要么就是不展示自定义参数,要么就是展示有问题,比如出现下图这样的
在这里插入图片描述
问题出现在param选项,网上很多使用的groovyScript(“def result=’’; def params=”KaTeX parse error: Can't use function '\"' in math mode at position 5: {_1}\̲"̲.replaceAll('[\…{_1}".replaceAll(’[\\[|\\]|\\s]’, ‘’).split(’,’).toList(); result+=’* @param ’ + params[0] + ‘\n’;for(i = 1; i < params.size(); i++) {result+=’ * @param ’ + params[i] + ((i < params.size() - 1) ? ‘\n’ : ‘’)}; return result", methodParameters()) ,这两种都会出现上图问题,正确的应该使用,如下代码,直接粘到param参数设置中,

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

如图

在这里插入图片描述
点击确定即可,最后在需要加注释的方法上使用 */abb -> 回车,如果在By default expand with不是设置回车键,记得使用自己设置的键位哦

  • 4
    点赞
  • 3
    收藏
    觉得还不错? 一键收藏
  • 2
    评论
在IntelliJ IDEA中,你可以自定义方法注释模板来快速生成常见的注释结构。这可以帮助提高编码效率,减少手动输入的时间。以下是设置方法注释模板的步骤: 1. **打开模板管理器**: - 点击菜单栏的 "File" -> "Settings"(Windows/Linux)或 "IntelliJ IDEA" -> "Preferences"(macOS),然后选择 "Editor" -> "Live Templates". 2. **查看或创建新的注释模板**: - 在左侧导航窗格找到并展开 "Live Templates" > "Java",你会看到已经存在的模板列表。 - 如果你想创建一个新的模板,点击 "+" 添加新模板。 3. **编辑模板内容**: - 输入模板名,例如 `doccomment` 或者更具体的名称,如 `getter` 对于get方法注释。 - 插入模板的占位符,比如 `${name}` 表示方法名,`${type}` 表示返回类型等。你可以在右侧的文本框中输入完整的注释模板,如 `/** ${name}(${params}): ${returnType} */`。 4. **关联模板到方法**: - 在占位符旁边添加条件标签,例如 `${if}` 和 `${else}` 来根据方法的不同特性(如是否是静态、有无参数等)动态插入内容。 5. **保存并应用**: - 确认模板内容无误后,点击 "OK" 保存设置。现在,当你开始编写方法并在相应的触发点使用快捷键(通常是 `<Ctrl + Alt + T>`),就会自动填入你刚才设置的模板了。 记得在日常工作中经常调整模板使其适应你的编程风格和个人偏好。如果你不清楚哪些占位符可用,可以直接在模板管理器里查看预设选项。
评论 2
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值