java單行、多行和文檔注釋

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

Java300集_零基礎(chǔ)_嗶哩嗶哩_bilibili

 Java 支持以下三種注釋方式:

  1)單行注釋以雙斜杠“//”標(biāo)識,只能注釋一行內(nèi)容,用在注釋信息內(nèi)容少的地方。打開 Eclipse,在 Java 代碼中使用單行注釋,如圖 1 所示。

  圖 1 單行注釋

2)多行注釋

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

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

圖 2 多行注釋

 3)文檔注釋

  包含在“/**”和“*/”之間,也能注釋多行內(nèi)容,一般用在類、方法和變量上面,用來描述其作用。注釋后,鼠標(biāo)放在類和變量上面會自動顯示出我們注釋的內(nèi)容,如圖 3 所示。

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

 圖 3 文檔注釋

 文檔注釋可以通過 Javadoc 命令把文檔注釋中的內(nèi)容生成文檔,并輸出到 HTML 文件中,方便記錄程序信息。還可以包含一個(gè)或多個(gè) @ 標(biāo)簽,每個(gè) @ 標(biāo)簽都在新的一行開始。關(guān)于 Javadoc 的具體標(biāo)簽和使用可閱讀學(xué)習(xí)《Javadoc入門教程》一節(jié)。

  在 Java 中,一行注釋以雙斜杠“//”標(biāo)識;多行注釋包含在“/*”和“*/”之間;文檔注釋包含在“/**”和“*/”之間。當(dāng)編譯器執(zhí)行到“//”時(shí),就會忽略該行“//”之后的所有文本;當(dāng)執(zhí)行到“/*”時(shí),會掃描下一個(gè)“*/”并忽略“/*”和“*/”之間的任何文本;當(dāng)執(zhí)行到“/**”時(shí),也會掃描下一個(gè)“*/”并忽略“/**”和“*/”之間的任何文本內(nèi)容。

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成,瀏覽時(shí)請結(jié)合常識與多方信息審慎甄別。
平臺聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點(diǎn),簡書系信息發(fā)布平臺,僅提供信息存儲服務(wù)。

相關(guān)閱讀更多精彩內(nèi)容

友情鏈接更多精彩內(nèi)容