IDEA 方法注释设置(包括获取参数)修改版:添加指定光标位置,类注解

写在最前:因为我后续使用过程中有修改,文中所有关于名字的地方都可以自行设置,自己喜欢就好,不必因为命名不一样而纠结

另:类注释添加在最后

1、File––>Setting––>Editor—>Live Templates:添加一个自己的注释模板组;可以在组内添加多个只是模板

在这里插入图片描述

2、设置模板组名:名字随意

在这里插入图片描述

3、选择设置具体模板参数

在这里插入图片描述

4、设置触发值

在这里插入图片描述

触发值和提示的效果(如此单独使用的时候会无法获取参数列表,获取参数列表方法接着往下)

在这里插入图片描述

5、添加注释模板(切记住开头不能加 /;因为使用的时候是/*f + enter键否则无法获取参数)

*
 * $END$
 * @author lhr
 $param$
 * @return $return$
 * @version V1.0.0
 * @date $time$ $date$
 */

!!!这里@Author $user$获取的是你设置的电脑用户名;用户可以写固定值@Author XXXXXX替换成你想写的名字即可;$END$是添加完注释之后光标的位置,$END$写在哪里光标就在哪里;但是阿里巴巴代码规范是方法描述写在最上边
在这里插入图片描述

6、设置执行按键

在这里插入图片描述

7、设置适用范围

在这里插入图片描述

下拉找到java,选择以后,点击空白处退出

在这里插入图片描述

8、设置模板内各项的值

在这里插入图片描述

按照图中选择选择即可:每项下拉找到对应的即可

重点来了:设置参数列表

在param的Expression选项中输入以下代码:直接粘贴复制即可

这是参数后有冒号的

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

有冒号在这里插入图片描述

这是参数后没有冒号的

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

无冒号在这里插入图片描述

设置好后

在这里插入图片描述

最后点击OK,点击APPLY,最后点击OK即可

在这里插入图片描述

9、使用方法(我设置的触发值是 ff ,执行键是enter)

在方法上输入 /*ff按Enter键即可

在这里插入图片描述

效果图

在这里插入图片描述

10、补充:有的方法不许要参数和返回值,我们可以在设置一个无参无返回值的方法注释:按照3~9操作即可,第3步那里换个名字即可

模板

/**
 * $END$
 * @author $USER$
 * @date $time$ $date$ 
 */

在这里插入图片描述

效果图

在这里插入图片描述
在这里插入图片描述

方法描述写在最上符合阿里巴巴代码规范,方法名不报警告

在这里插入图片描述

否则的话方法名会报警告

11、类注解

File––>Setting––>Editor—>File and Code Templates:Files:Class

在这里插入图片描述

模板:无需其他设置,全部自动生成

/**
 *@belongsProject: ${PROJECT_NAME}
 *@belongsPackage: ${PACKAGE_NAME}
 *@author: ${USER}
 *@description: ${Description}
 *@version v1.0.0
 *@createTime: ${YEAR}-${MONTH}-${DAY} ${HOUR}:${MINUTE}
*/

@belongsProject: 所属项目
@belongsPackage: 所在包
@author: 作者(电脑名,可以直接写名字把${USER}删除即可)
@description: 类描述(创建类是提示框提示添加)
@version 类版本
@createTime: 创建时间(自动生成)

添加类描述

在这里插入图片描述

效果图

在这里插入图片描述
在这里插入图片描述

还可以给枚举、接口添加,方法如上

在这里插入图片描述

  • 7
    点赞
  • 13
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
idea方法注释模板是编写代码时用于对方法进行注解的一种格式化规范。它的主要目的是提供给代码阅读者(包括自己和他人)关于方法功能、输入输出以及其他相关信息的快速概览。下面是一个常见的带注解idea方法注释模板示例: ``` /** * 方法名称:methodExample * 描述:这是一个示例方法,用于展示idea方法注释模板的使用。 * 参数: * - param1: 参数1的说明,型为xxx。 * - param2: 参数2的说明,型为xxx。 * 返回值:返回值的说明,型为xxx。 * 抛出异常: * - Exception1:异常1的说明。 * - Exception2:异常2的说明。 * 作者:作者的姓名 * 创建时间:方法创建的时间 * 版本:方法的版本信息 */ public returnType methodExample(param1, param2) throws Exception1, Exception2 { // 方法体 } ``` 在这个示例中,我们可以看到该注释模板的结构和内容。注释的开头是一个多行注释的开始符号(`/**`),接着是对方法名称的注释,然后是方法的描述,接下来是对参数、返回值和异常的注释,最后是对作者、创建时间以及版本的注释。 借助这个模板,我们可以清晰地了解一个方法的作用、输入输出、异常等重要信息。这对于自己回顾代码或者他人阅读、维护代码都非常有帮助。同时,注释模板也促使开发者在编写方法时思考清楚这些方面的内容,提高了代码的可读性和可维护性。 当然,一个好的注释模板可能因不同的团队、项目和个人而有所不同。因此,我们可以根据实际情况调整和定制这个模板,以适应自己团队和项目的需要。

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

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

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值