在編寫程序時(shí),經(jīng)常需要添加一些注釋,用以描述某段代碼的作用。
一般來(lái)說(shuō),對(duì)于一份規(guī)范的程序源代碼而言,注釋應(yīng)該占到源代碼的 1/3 以上。因此,注釋是程序源代碼的重要組成部分,一定要加以重視哦!
Java 中注釋有三種類型:單行注釋、多行注釋、文檔注釋
運(yùn)行結(jié)果: Hello Imooc!
看:被注釋的代碼塊在程序運(yùn)行時(shí)是不會(huì)被執(zhí)行的~~
我們可以通過(guò) javadoc 命令從文檔注釋中提取內(nèi)容,生成程序的 API 幫助文檔。
打開(kāi)首頁(yè),查看下生成的 API 文檔
PS:使用文檔注釋時(shí)還可以使用 javadoc 標(biāo)記,生成更詳細(xì)的文檔信息:
@author 標(biāo)明開(kāi)發(fā)該類模塊的作者
@version 標(biāo)明該類模塊的版本
@see 參考轉(zhuǎn)向,也就是相關(guān)主題
@param 對(duì)方法中某參數(shù)的說(shuō)明
@return 對(duì)方法返回值的說(shuō)明
@exception 對(duì)方法可能拋出的異常進(jìn)行說(shuō)明
親,你掌握注釋該如何添加了么?
請(qǐng)?jiān)诰庉嬈髦?,使用單行注釋將?strong> 3 行中的代碼注釋掉, 使用多行注釋將第 5、6 兩行中的代碼注釋掉
運(yùn)行結(jié)果: imooc
單行注釋以雙斜線 // 開(kāi)頭,多行注釋以 /* 開(kāi)頭,以 */ 結(jié)尾
請(qǐng)驗(yàn)證,完成請(qǐng)求
由于請(qǐng)求次數(shù)過(guò)多,請(qǐng)先驗(yàn)證,完成再次請(qǐng)求
打開(kāi)微信掃碼自動(dòng)綁定
綁定后可得到
使用 Ctrl+D 可將課程添加到書(shū)簽
舉報(bào)