Java基礎01：註釋

KNONO發表於2024-07-11
Java

Java 註釋主要有三種型別：

  • 單行註釋
  • 多行註釋
  • 文件註釋

單行註釋

單行註釋以雙斜槓 // 開始：

// 這是一個單行註釋
int x = 10; // 初始化一個變數x為10

多行註釋

多行註釋以 /*開始，以 */結束：

/*
這是一個多行註釋
可以用來註釋多行程式碼
*/
int y = 20; // 初始化一個變數y為20

文件註釋

文件註釋以 /** 開始，以 */ 結束，通常出現在類、方法、欄位等的宣告前面，用於生成程式碼文件，這種註釋可以被工具提取並生成 API 文件，如 JavaDoc。

/**
 * 這是一個文件註釋示例
 * 它通常包含有關類、方法或欄位的詳細資訊
 */
public class MyClass {
    // 類的成員和方法
}

文件註釋的格式通常包含一些特定的標籤，如 @param 用於描述方法引數，@return 用於描述返回值，@throws 用於描述可能丟擲的異常等等，這些標籤有助於生成清晰的API文件，以便其他開發者能夠更好地理解和使用你的程式碼。

相關文章