Java 注释

---

---

Java 注释

Java 注释 是写在代码中的文本注释，用于解释源代码。注释可以用来解释逻辑或用于文档目的。编译器不会编译注释。在 Java 中，注释与 C 和 C++ 非常相似。

在 Java 中，有三种类型的注释

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

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

1. 单行注释

单行注释用于在一行上添加注释，可以使用两个正斜杠 (//) 来编写。这些注释是最常用的注释方式。

单行注释是最常用的注释方式，用于解释该行的目的（或添加文本注释）。

语法

考虑以下语法在 Java 中编写单行注释

// comment

示例 1：Java 单行注释

// if divisor is 0 throw an exception
if (divisor == 0) {
   throw new IllegalArgumentException("divisor cannot be zero");
}

示例 2：Java 单行注释

以下代码显示了在简单程序中使用单行注释的情况。我们已向代码行添加注释以解释其用途。

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 is 0 throw an exception
      if (divisor == 0) {
         throw new IllegalArgumentException("divisor cannot be zero");
      }
      return (double) dividend / divisor; // returns the result of the division as double
   }
}

输出

编译并运行 MyFirstJavaProgram。这将产生以下结果：

10.0

2. 多行注释

多行（或多行）注释以正斜杠后跟星号 (/*) 开始，以星号后跟正斜杠 (*/) 结束，它们用于在多行上添加注释。

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

语法

考虑以下语法在 Java 中编写多行注释

/*
Comment (line 1)
Comment (line 2)
...
*/

示例 1：Java 多行注释

/* This is an example 
of 
multi line comment. */

/* if (dividend == 0) {
   throw new IllegalArgumentException("dividend cannot be zero");
} */

示例 2：Java 多行注释

以下代码显示了在简单程序中使用多行注释的情况。我们使用多行注释注释掉了方法中的额外代码。

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("divisor cannot be zero");
      }
      /* if (dividend == 0) {
         throw new IllegalArgumentException("dividend cannot be zero");
      } */
      return (double) dividend / divisor;
   }
}

输出

编译并运行 MyFirstJavaProgram。这将产生以下结果：

10.0

3. 文档注释

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

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

语法

考虑以下语法在 Java 中编写文档注释

/**
* line 1
* line 2
...
*/

示例 1：Java 文档注释

/**
 * This is a documentation comment.
 * This is my first Java program.
 * This will print 'Hello World' as the output
 * This is an example of multi-line comments.
*/
public class MyFirstJavaProgram {}

上述注释风格称为文档注释。Javadoc 工具在为程序代码创建文档时会使用它。我们还可以使用文档注释中的以下注解来提供参数、异常和返回类型的详细信息。

/**
 * @param dividend
 * @param divisor
 * @return quotient
 * @throws IllegalArgumentException if divisor is zero
 */
private double divide(int dividend, int divisor) throws IllegalArgumentException {
}

示例 2：Java 文档注释

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

package com.tutorialspoint;

/**
 * This is a documentation comment. 
 * This is my first Java program.
 * This is an example of multi-line comments.
 * We're printing result of divison of two numbers in this program
 */
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 quotient
    * @throws IllegalArgumentException if divisor is zero
    */
   private double divide(int dividend, int divisor) throws IllegalArgumentException {
      if (divisor == 0) {
         throw new IllegalArgumentException("divisor cannot be zero");
      }
      return (double) dividend / divisor;
   }
}

输出

编译并运行 MyFirstJavaProgram。这将产生以下结果：

10.0