Java注釋：單行、多行和文檔注釋

[toc]

注釋是對程序語言的說明，有助于開發(fā)者和用戶之間的交流，方便理解程序。注釋不是編程語句，因此被編譯器忽略。

Java支持三種注釋：單行注釋，多行注釋，文檔注釋。

一 單行注釋

以雙斜杠“//”標識，只能注釋一行內(nèi)容，用在語句后面或者注釋信息內(nèi)容少的地方。

如下所示：

    System.out.println("單行注釋方式。");//這是單行注釋方式，放在代碼行后面。
    //這也是是單行注釋方式。
    System.out.println("這也是單行注釋方式，放在代碼行上面。");

二 多行注釋

包含在"/*"和“*/”之間，能注釋很多行的內(nèi)容。為了可讀性比較好，一般首行和尾行不寫注釋信息（這樣也比較美觀好看），如下 所示。

注意：多行注釋可以嵌套單行注釋，但是不能嵌套多行注釋和文檔注釋。

    /*
    *  這是多行注釋，
    *  可以注釋多行內(nèi)容。
    *  這里的*是可以去掉的。
    *  為了美觀，IDEA自動加上了。
    *  //這里嵌套了單行注釋。
    */
    System.out.println("多行注釋方式。");

三 文檔注釋

包含在“/**”和“*/”之間，也能注釋多行內(nèi)容，一般用在類、方法和變量上面(這幾個概念后面會講)，用來描述其作用。注釋后，鼠標放在類和變量上面會自動顯示出我們注釋的內(nèi)容，如下所示。

注意：文檔注釋能嵌套單行注釋，不能嵌套多行注釋和文檔注釋，一般首行和尾行也不寫注釋信息。

/**
 *  這文檔注釋，
 *  可以注釋多行內(nèi)容。
 *  這里的*是可以去掉的。
 *  為了美觀，IDEA自動加上了。
 *  //這里嵌套了單行注釋。
 *  這里注釋用在了類上。
 */
public class JavaComment {
    ... 
}

了解一下：文檔注釋可以通過 Javadoc 命令把文檔注釋中的內(nèi)容生成文檔，并輸出到 HTML 文件中，方便記錄程序信息。還可以包含一個或多個 @ 標簽，每個 @ 標簽都在新的一行開始。

四 懸停查看文檔注釋

如下圖，將鼠標懸停標記1，在println方法的位置，可以看到自動彈出來對于該方法的文檔注釋。

文檔注釋查看

五 空格

空白行或者有注釋的行，Java 編譯器都會忽略掉。也就是說代碼中的空白行可以是任意的，只要不影響美觀和閱讀?？招幸话阋彩菫榱嗣烙^閱讀。

文章和項目開源地址

一起學習，Java最簡單易懂的零基礎(chǔ)入門，答疑解惑，關(guān)注點贊github開源：https://github.com/BradYan/easy-java