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