Java 注释

Java 注释

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

在 Java 中，注释分为三种类型:

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

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

1.单行注释

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

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

语法

请考虑使用以下语法在 Java 中编写单行注释:

// 注释内容

示例 1:Java 单行注释

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

示例 2: Java 单行注释

以下代码显示了在简单程序中单行注释的用法。我们在代码行中添加了注释来解释其用途。

package com.yxjc123;

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("divisor cannot be zero");
      }
      return (double) dividend / divisor; // 将除法结果返回为 double
   }
} 

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

10.0 

2. 多行注释

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

当我们想要将长注释分散到多行或注释掉完整的代码。

语法:

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

/*
注释 (line 1)
注释 (line 2)
...
*/ 

示例 1:Java 多行注释

/* 这是多行
注释 
例子. */

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

示例 2:Java 多行注释

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

package com.yxjc123;

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.yxjc123;

/**
 * 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