在 Java 中,有三種常用的注釋形式:單行注釋、多行注釋和文檔注釋。
1. 單行注釋:以雙斜線 (`//`) 開始,用于在一行內(nèi)注釋單個語句或說明代碼的含義。
java
// 這是一個單行注釋
int x = 5; // 初始化變量 x
2. 多行注釋:以斜線加星號 (`/*`) 開始,以星號加斜線 (`*/`) 結(jié)束,用于注釋多行代碼或較長的說明。
java
/*
這是一個多行注釋
它可以跨越多行,用于注釋多個語句或一段代碼
*/
int x = 5;
int y = 10;
3. 文檔注釋:以斜線加星號加兩個星號 (`/**`) 開始,以星號加斜線 (`*/`) 結(jié)束,用于為類、方法、字段等編寫詳細的文檔說明。文檔注釋可以通過工具生成文檔,如使用 `javadoc` 工具生成 API 文檔。
java
/**
* 這是一個文檔注釋
* 用于對類、方法、字段等進行詳細的文檔說明
*/
public class MyClass {
/**
* 這是一個方法的文檔注釋
* @param x 參數(shù) x
* @param y 參數(shù) y
* @return 返回結(jié)果
*/
public int add(int x, int y) {
return x + y;
}
}
文檔注釋使用特殊的標記(`@`)和標記名稱,例如 `@param` 用于描述方法的參數(shù),`@return` 用于描述方法的返回值。通過在代碼中使用文檔注釋,可以為其他開發(fā)人員提供清晰的代碼文檔和使用說明。
注意,注釋是用于解釋代碼和提供文檔,不會被編譯器編譯和執(zhí)行。注釋不會對程序的運行產(chǎn)生任何影響,僅供開發(fā)人員閱讀和理解代碼。