註釋是Java代碼中非常重要的一部分，它就像給代碼寫“說明書”，能讓代碼更清晰易懂，方便自己和他人理解代碼邏輯，也能在調試時快速定位問題。編譯器會自動忽略註釋內容，所以註釋不會影響代碼的執行。下面我們來詳細瞭解Java中的三種註釋類型：單行註釋、多行註釋和文檔註釋。
一、單行註釋（//）¶
格式：使用 // 開頭，後面緊跟註釋內容，只能註釋單行。
示例：
// 這是單行註釋，我可以寫在代碼行的後面
int score = 95; // 定義學生的分數爲95分
// 也可以單獨寫一行，解釋某段代碼的作用
// 比如下面這行是計算兩個數的和
int sum = 10 + 20;
注意：
- 單行註釋只能註釋單行內容，不能跨多行。如果要註釋多行，需要每行都用 //。
- 單行註釋不能嵌套使用，比如 // 這是// 嵌套的註釋 會被編譯器認爲是語法錯誤。
二、多行註釋（/ /）¶
格式：使用 /* 開頭，*/ 結尾，中間可以包含多行內容。
示例：
/*
這是多行註釋，可以跨越多行
我可以在這裏寫對一段代碼的詳細說明
比如下面這個方法的作用是打印用戶信息
*/
public void printUserInfo(String name, int age) {
System.out.println("姓名：" + name + "，年齡：" + age);
}
/*
注意：多行註釋不能嵌套！
比如下面這種寫法會報錯：
/* 這是嵌套註釋 */
// 正確的寫法是：
// 把嵌套的部分當成普通代碼處理，或者拆分成多個單行註釋
注意：
- 多行註釋可以跨多行，但不能嵌套（即不能在 /* */ 內部再寫 /* */）。
- 多行註釋通常用於解釋一段代碼的整體邏輯，比如類的作用、複雜算法的步驟等。
三、文檔註釋（/* /）¶
格式：使用 /** 開頭，*/ 結尾，專門用於生成API文檔（比如用Javadoc工具生成幫助文檔）。
特點：可以包含標籤（如 @author、@param、@return 等），但對初學者來說，先掌握基本格式即可。
示例：
/**
* 這是文檔註釋，用於生成幫助文檔
* @author 小明（作者信息）
* @version 1.0（版本號）
*
* 這個類用於管理用戶信息
*/
public class User {
private String name;
private int age;
/**
* 構造方法，初始化用戶信息
* @param name 用戶姓名
* @param age 用戶年齡
*/
public User(String name, int age) {
this.name = name;
this.age = age;
}
}
作用：通過Javadoc工具（Java自帶的文檔生成工具），可以將文檔註釋自動生成HTML格式的API文檔，方便他人查看類、方法、字段的說明。
註釋的規範與建議¶
- 不要寫冗餘註釋：比如
// 定義變量這種無意義的註釋，直接寫代碼更清晰。 - 突出重點：註釋要解釋“爲什麼這麼寫”“這段代碼的作用”，而不是“這行代碼做了什麼”。
- 及時更新註釋：如果代碼邏輯修改了，註釋也要同步更新，避免誤導他人。
- 合理使用位置：
- 類/接口：用文檔註釋（/** */）說明功能。
- 方法：用文檔註釋說明參數、返回值、異常等。
- 複雜邏輯：用多行註釋（/* */）拆解步驟。
- 變量/代碼行：用單行註釋（//）補充說明。
總結¶
- 單行註釋：快速註釋單行內容，適合簡短說明。
- 多行註釋：解釋一段代碼的整體邏輯，適合複雜邏輯。
- 文檔註釋：生成API文檔，適合類、方法的規範說明。
合理使用註釋能讓你的代碼“會說話”，既方便自己後續維護，也能讓團隊協作更順暢。記住：好的註釋是代碼質量的加分項，而不是負擔哦！