IDEA 自定义注解(类注释、方法注释)


一、生成类注释

1、打开设置位置

打开File —> Settings —> Editor —> File and Code Templates —> Files —> Class

图片 1—1

2、将自定义的类注解规则,复制到Class中。

/**
* @program: ${PROJECT_NAME}
*
* @description: ${description}
*
* @author: lydms
*
* @create: ${YEAR}-${MONTH}-${DAY} ${HOUR}:${MINUTE}
**/

添加后内容:
在这里插入图片描述

3、使用:新建类的时候会自动加上注解

  1. 新建类

在这里插入图片描述

  1. 添加类上注解(会加到@discrimination中)

在这里插入图片描述

  1. 创建完成新的类

在这里插入图片描述

二、自定义方法注解

1、打开设置

打开File —> Settings —> Editor —> Live Templates

在这里插入图片描述

2、添加自定义注解模板组

在这里插入图片描述

3、添加自定义注解模板

在这里插入图片描述

文本中的内容

** 
* @Description: $description$
* @Param: $params$
* @return: $returns$
* @Author: lydms
* @Date: $date$
*/

4、设置模板的作用范围

在这里插入图片描述

5、自定义㢟规则

在这里插入图片描述

6、使用自定义注解

在类上方使用/**+Tab触发自定义注解
在这里插入图片描述

三、注意事项

1、在类上注解,没有显示入参和返回值

首先,试一下在类中使用是否正常。假如正常的话,就是自定义的规则里,多了一个/符号,以及开启自定义注解前没有加/符号。

2、自定义注解参数及使用方式

自定义注解开头的一定是没有/的,假如加上了,就只能在方法中使用,在方法外使用的话,是不会有入参和返回值的参数的。

** 
* @Description: $description$
* @Param: $params$
* @return: $returns$
* @Author: lydms
* @Date: $date$
*/

使用自定义注解的方式,一定是/+**然后再使用Tab键,进行触发的。

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

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

打赏作者

ha_lydms

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

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

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

打赏作者

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

抵扣说明:

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

余额充值