IDEA中设置类或方法的注释模板

定义Live Templates模板

1、类注释模板

/**
 * @ClassName: $className$
 * @Description: 类描述
 * @author: xxx
 * @date: $DATE$ $TIME$
 */

 编辑模板变量:

2、方法注释模板

方法模板需要动态获取方法的参数及返回类型,可以借助groovyScript

**
 * @Title: $methodName$
 * @Description: 方法描述
 $params$
 * @return: $returnType$
 */

编辑模板变量:

 params变量groovyScript脚本:

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==0){result+='* @param ' + params[i] + ': '}else{result+='\\n' + ' * @param ' + params[i] + ': '}}; return result;}", methodParameters());

使用的时候也得注意:"/" + 模板Abbreviation + tab

其他脚本示例:

// 输出package

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

// 输出class

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

================================================

 * @throws: $exception$

方法抛出异常注释没有解决,希望有搞出来的大神给补充一下


文件头模板

模板内容:

/**
 * 文件名: ${NAME}.java
 * 版权: Copyright 2020-2023 xxx All Rights Reserved.
 * 描述: XXX XXX
 */

如下图所示:

注意: 这样默认的效果是文件头注释会放到package之后,如果想放到package之前,还需要做如下设置

文件模板也可以在Live Templates中定义,如下图:

  • 3
    点赞
  • 1
    收藏
    觉得还不错? 一键收藏
  • 打赏
    打赏
  • 0
    评论
IDEA,有几种快捷键可以帮助你添加注释模板。首先是行注释快捷键,按下Ctrl + /,可以在光标所在行的行首添加"//",将该行注释掉。再次按下Ctrl + /,可以取消该行的注释。 接下来是块注释快捷键,使用前需要先选注释的代码块。按下Ctrl + Shift + /,可以将选的代码块注释掉。如果想要取消注释,只需将光标放在注释的内容上,然后按下Ctrl + Shift + /即可。 最后是方法或类注释的快捷键。在一个方法或类的开头,输入/**,然后按下回车键,IDEA会自动根据参数和返回值生成注释模板。你可以在这个模板的上方编写注释内容。 综上所述,IDEA注释模板的快捷键包括行注释Ctrl + /,块注释Ctrl + Shift + /,以及方法或类注释的自动生成模板。<span class="em">1</span><span class="em">2</span><span class="em">3</span> #### 引用[.reference_title] - *1* [IntelliJ IDEA添加注释常用的快捷键](https://blog.csdn.net/wyf2017/article/details/81178675)[target="_blank" data-report-click={"spm":"1018.2226.3001.9630","extra":{"utm_source":"vip_chatgpt_common_search_pc_result","utm_medium":"distribute.pc_search_result.none-task-cask-2~all~insert_cask~default-1-null.142^v93^chatsearchT3_1"}}] [.reference_item style="max-width: 50%"] - *2* *3* [idea注释的快捷键三种方式](https://blog.csdn.net/weixin_44371237/article/details/127526827)[target="_blank" data-report-click={"spm":"1018.2226.3001.9630","extra":{"utm_source":"vip_chatgpt_common_search_pc_result","utm_medium":"distribute.pc_search_result.none-task-cask-2~all~insert_cask~default-1-null.142^v93^chatsearchT3_1"}}] [.reference_item style="max-width: 50%"] [ .reference_list ]

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

wsdhla

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

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

余额充值