Java 块注释

Aryan Tyagi 2023年10月12日

Java Java Comment

在 Java 中，我们使用注释通过提供有关代码的附加说明和信息来提高 Java 代码的可读性，从而帮助维护代码并轻松查找错误和错误。在编译 java 代码时，编译器完全排除了注释中的文本和语句。

我们将在本教程中讨论 Java 中的块注释。

块注释用于同时注释多行代码。我们使用 /* 和 */ 来插入块注释。块注释可以扩展到多行或插入到代码语句中。只有在注释分隔符之间看到的文本才被视为注释，在编译期间被忽略。

例如，

public class multilinecomment {
  public static void main(String[] args) {
    /* we have declared an integer n having value 007
    and a floating point variable z
    storing value of pi. */
    int n = 007;
    double z = 3.14;
    System.out.println(n);
    System.out.println(z);
  }
}

输出：

7
3.14

Java 中还有另一种类型的多行注释。为此，我们使用 /** 和 */ 来包含文档注释。这用于为由 javadoc 工具创建的程序定义正式的文档 API。javadoc 是一种工具，用于解析源文件集合中的声明和文档注释，并生成描述类、接口、构造函数、方法和字段的 HTML 页面集合。

例如，

public class javadoccomment {
  /**  multi() method returns multiplication of numbers.*/
  public static int multi(int a, int b) {
    return a * b;
  }

  /**  addition() method returns addition of numbers.*/
  public static int addition(int a, int b) {
    return a + b;
  }

  /**  subtract() method returns subtraction of numbers.*/
  public static int subtract(int a, int b) {
    return a - b;
  }
  public static void main(String[] args) {}
}

当我们通过 javac 工具编译上面给出的代码时，我们得到 javadoccomment.java，然后为类 javadoccomment 创建一个 HTML 文件。打开给定的 HTML 文件并查看 javadoccomment 类的文档注释。