Java 注释

Java 注释是用来为源代码提供解释的文字说明。注释可用于解释逻辑或用于文档目的。编译器不会编译注释。Java 中的注释与 C 和 C++ 非常相似。

Java 中有三种类型的注释：

单行注释
多行注释
文档注释

让我们详细讨论每种类型的注释。

1. 单行注释

单行注释用来在一行内添加注释，可以通过使用两个正斜杠（//）来书写。这些注释是最常用的注释方式。

单行注释最常用来解释某一行的目的或添加文本注释。

语法：

// 注释

示例 1：

// 如果除数为 0 则抛出异常
if (divisor == 0) {
   throw new IllegalArgumentException("除数不能为零");
}

示例 2：以下代码展示了在一个简单的程序中使用单行注释。我们在代码行中添加了注释来解释它们的作用。

package com.tutorialspoint;

public class MyFirstJavaProgram {
   public static void main(String[] args) {
      MyFirstJavaProgram program = new MyFirstJavaProgram();
      double result = program.divide(100, 10);
      System.out.println(result);
   }

   private double divide(int dividend, int divisor) throws IllegalArgumentException {
      // 如果除数为 0 则抛出异常
      if (divisor == 0) {
         throw new IllegalArgumentException("除数不能为零");
      }
      return (double) dividend / divisor; // 返回除法的结果作为双精度浮点数
   }
}

输出：

10.0

2. 多行注释

多行注释开始于一个正斜杠后跟一个星号（/），结束于一个星号后跟一个正斜杠（/），并且用于在多行上添加注释。

当需要放置跨越多行的长注释或注释掉完整的代码时，多行注释非常有用。

语法：

/*
注释（第 1 行）
注释（第 2 行）
...
*/

示例 1：

/* 这是一个例子
多行注释。 */
/* 如果被除数为 0 则抛出异常 */

示例 2：以下代码展示了一个简单的程序中使用多个注释的情况。我们使用多行注释从方法中注释掉了额外的代码。

package com.tutorialspoint;

public class MyFirstJavaProgram {
   public static void main(String[] args) {
      MyFirstJavaProgram program = new MyFirstJavaProgram();
      double result = program.divide(100, 10);
      System.out.println(result);
   }

   private double divide(int dividend, int divisor) throws IllegalArgumentException {
      if (divisor == 0) {
         throw new IllegalArgumentException("除数不能为零");
      }
      /* 如果被除数为 0 则抛出异常 */
      return (double) dividend / divisor;
   }
}

输出：

10.0

3. 文档注释

文档注释用于编写源代码的文档。文档注释开始于一个正斜杠后跟两个星号（/*），结束于一个星号后跟一个反斜杠（/），并且所有行之间必须以星号（*）开头。

文档注释由 Javadoc 工具理解，并且可以用来创建基于 HTML 的文档。

语法：

/**
* 第 1 行
* 第 2 行
...
*/

示例 1：

/**
 * 这是一个文档注释。
 * 这是我的第一个 Java 程序。
 * 这将会输出 'Hello World'
 * 这是多行注释的例子。
 */
public class MyFirstJavaProgram {}

以上注释风格称为文档注释。它在创建程序代码的文档时由 Javadoc 工具使用。我们可以使用以下注释在文档注释中给出参数、异常和返回类型的信息：

/**
 * @param dividend
 * @param divisor
 * @return 商
 * @throws IllegalArgumentException 如果除数为零
 */
private double divide(int dividend, int divisor) throws IllegalArgumentException {
}

示例 2：以下代码展示了一个简单的程序中使用文档注释的情况。我们在类声明上定义了注释来描述类的细节。对于方法，我们在方法注释部分的文档块中添加了参数、返回值和引发异常的详情。

package com.tutorialspoint;

/**
 * 这是一个文档注释。
 * 这是我的第一个 Java 程序。
 * 这是一个多行注释的例子。
 * 我们在这个程序中打印两个数相除的结果。
 */
public class MyFirstJavaProgram {
   public static void main(String[] args) {
      MyFirstJavaProgram program = new MyFirstJavaProgram();
      double result = program.divide(100, 10);
      System.out.println(result);
   }

   /**
    * @param dividend
    * @param divisor
    * @return 商
    * @throws IllegalArgumentException 如果除数为零
    */
   private double divide(int dividend, int divisor) throws IllegalArgumentException {
      if (divisor == 0) {
         throw new IllegalArgumentException("除数不能为零");
      }
      return (double) dividend / divisor;
   }
}

输出：

10.0

以上就是 Java 中的三种注释类型及其用法。