Java 塊註釋

Aryan Tyagi 2023年10月12日
Java 塊註釋

在 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 類的文件註釋。