【Java】Java中的注解简介

不念不忘少年蓝@ 2023-10-12 22:07 23阅读 0赞

> **本文仅供学习参考！**

![请添加图片描述][5b8f868fb41040faa3822e02808877ef.jpeg]

在 Java 中，*注释*是应用于类、接口、方法或字段的元数据，以便向编译器提供有关程序的附加信息。换句话说，注释提供了一种提供有关特定程序构造（如类、方法、变量等）的元数据信息的方法。

在本文中，我们将了解如何在 Java 中使用不同类型的注释，同时提供一些编码示例以使学习过程更容易。

### 什么是 Java 注解？ ###

注释可用于将元数据添加到代码中，通常出现在方法或变量定义之前。注解不会修改程序的结构或其行为；相反，它们允许您轻松添加有关源代码中元素的上下文信息。

注释是元数据的一种形式，提供有关源代码中元素的补充信息。注解是 Java 语言的一项强大功能，可以使您的代码更具可读性且更易于维护。Java 注释首次在 JDK 5.0 中引入，从此成为 Java 语言不可或缺的一部分。

如前所述，注释是提供有关 Java 元素的元数据的一种方式。它们用于多种目的，包括：

*  编译器指令
 *  代码生成
 *  运行时处理

Java 注释也是一种向 Java 代码添加元数据的方法。它们可用于多种目的，例如指定配置信息、记录代码以及提供可供工具使用的信息。

例如，注释可用于指示某个方法已被弃用，或者在调用不应再使用的方法时生成警告。工具可以使用此元数据来生成文档或自动配置系统。

### Java 中注释的好处 ###

编译器可以使用注释元数据来生成代码，也可以在运行时使用它来内省代码。注释可用于标记 Java 语言的方法、字段、类和其他元素。

需要注释的原因有很多。一个原因是它们提供了一种向 Java 代码添加不属于代码本身的信息的方法。此信息可供处理代码的工具使用，例如 IDE、构建工具等。

使用注释的另一个原因是它们可用于在运行时检查代码。这对于调试或创建需要在运行时访问有关代码结构的信息的动态应用程序非常有用。

注解的另一个好处是使您的代码易于理解、维护和重用，并提高代码的可读性。

最后，注释可以用作指定应用程序配置信息的一种方式。例如，注释可用于指定应将特定类公开为 Web 服务。

### Java 标准注解 ###

Java 中的注释是一个强大的工具，可用于提高代码质量。它们可用于添加有关代码的信息、指定依赖关系以及强制执行规则。

*  **@Override**：您可以利用此注释来指定子类的方法已覆盖超类的方法。这很重要，因为它可以帮助避免将代码升级到新版本的库时出现错误。
 *  **@Deprecated**：此注释用于将方法和类标记为已弃用。这对于指示不应再使用代码很有用，并且还可以帮助提供有关如何替换已弃用代码的指导。
 *  **@SuppressWarnings**：此注释用于抑制编译器发出的警告。当您想要暂时禁用警告以便您可以专注于代码的其他部分时，这会很有用。

### Java 中的注解类型 ###

Java中的注解有五种类型：

*  标记注释
 *  单值注释
 *  类型注释
 *  完整注释
 *  可重复注释

让我们仔细看看每种类型的注释。

#### Java 中的标记注释 ####

标记注释没有任何与其关联的值。标记注释的一个示例是\*\*@Override\*\*，它用于指示某个方法正在重写超类中的方法。

#### 单值注释 ####

单值注释有一个与其关联的值。单值注释的一个示例是\*\*@Deprecated\*\*，它用于将类、字段或方法标记为已弃用。已弃用意味着不应再使用该元素，并且可能会在未来版本中删除该元素。

#### 类型注释 ####

只要使用了类型，就会使用类型注释。例如，您可以使用它来注释方法的返回类型。

#### 完整注释 ####

Java 中的完整注释由多个数据成员、值、名称、对组成。

#### 可重复注释 ####

Java 中的重复注解是可以多次应用于某个项目的注解。

### Java 注解的用例 ###

Java 注释可以通过多种方式使用，例如：

*  指定类或方法的配置信息
 *  记录代码
 *  创建单元测试
 *  生成源代码
 *  提供可供工具使用的信息

### 如何用 Java 编写注释程序 ###

创建注释类型时，必须指定它包含的元素。对于每个元素，您必须指定其名称以及是否需要。如果未提供元素，您还可以指定元素的默认值。

以下代码清单说明了如何利用 Java 中的注释：

class Shape {
        
        public void display()
        {
        
            System.out.println("Base display()");
        }
    }
    public class Circle extends Shape {
        
        @Override public void display(int n)
        {
        
            // Print statement when this method is called
            System.out.println("Inside the derived class.");
        }
       public static void main(String args[])
        {
        
            Circle obj = new Circle();
            obj.display();
        }
    }

### END ###

如果使用得当，Java 注释是非常有用的。对代码进行注释可以使其更易于阅读和维护。此外，注释还可用于生成文档或在编译时强制执行某些规则。如果您没有在 Java 代码中使用注释，那么您现在应该考虑这样做。

[5b8f868fb41040faa3822e02808877ef.jpeg]: https://img-blog.csdnimg.cn/5b8f868fb41040faa3822e02808877ef.jpeg