如何在 Java 中创建自己的注释?

javaobject oriented programmingprogramming更新于 2024/9/24 14:36:17

当我们开始学习 Java 时,我们经常对 @override 和 @inherited 等符号感到疑惑。它们是一种称为注释的特殊标签,可以应用于类、方法、字段、参数和代码的其他元素。Java 提供了对一些内置注释的支持,但是,我们也被允许创建自己的注释。在本文中,我们将学习如何创建和使用我们自己的自定义注释。

在 Java 中创建自定义注释

在创建我们自己的注释之前,让我们先熟悉一下 Java 中注释的基础知识。

注释

它们是 Java 的一项强大功能,允许我们向代码添加元数据。在这里,术语元数据是指有关特定代码块的附加信息。它们可用于各种目的,包括文档、验证、测试、依赖注入等等。它们以 '@' 符号开头,可以具有提供附加信息的可选属性。

Java 支持两种类型的注释:内置和自定义。内置注释具有预定义的含义和行为。

以下是一些内置注释:

  • @Override:表示方法覆盖了超类或接口中的另一个方法。

  • @Deprecated:用于将元素标记为过时,以便在使用时生成警告。

  • @SuppressWarnings:抑制编译器警告。

到目前为止,我们已经介绍了注释及其一些预定义的注释。现在,让我们讨论如何创建自定义注释。

创建我们自己的注释

第一步是使用 @interface 关键字及其注释名称进行声明。然后,下一步是添加一些描述新创建的注释的属性。属性可以是一些变量。

语法

@interface nameOfAnnotation { // 声明
    // 属性
}
@nameOfAnnotation( values ) // 初始化

示例 1

在下面的示例中,我们将创建一个名为"Author_details"的注释,以及它的两个必需属性"name"和"email"。

// 声明注释
@interface Author_details {
   // 注释的属性
    String name();
    String email();
}
// 使用注释
@Author_details(name = "Shriansh Kumar", email = 
"shriansh.kumar@tp.com")
public class Example1 {
   public static void main(String[] args) {
      System.out.println("This is an example of Annotation");
   }
}

输出

This is an example of Annotation

示例 2

在下面的示例中,我们将声明一个名为"Author_details"的注释,以及它的两个默认属性"name"和"email"。要定义默认属性,我们需要使用"default"关键字。

// 声明注释
@interface Author_details {
    // 注释的属性
    String name() default "Shriansh Kumar";
    String email() default "shriansh.kumar@tp.com";
}
// 使用注释
@Author_details
public class Example2 {
   public static void main(String[] args) {
      System.out.println("This is an example of Annotation");
   }
}

输出

This is an example of Annotation

示例 3

在下面的示例中,我们将创建并使用单值注释。

// 声明注释
@interface Author_details {
    // 注释的属性
    String name() default "Shriansh Kumar";
}
// 使用注释
@Author_details
public class Example3 {
   public static void main(String[] args) {
      System.out.println("This is an example of Annotation");
   }
}

输出

This is an example of Annotation

结论

注释只是告诉我们有关代码块的信息,它不会影响整个代码的工作。在本文中,我们首先学习了内置注释,在后面的部分中,我们借助示例讨论了创建和使用自定义注释的过程。


相关文章


有用资源