魔方格魔方格合作機(jī)構(gòu)> 廣州培訓(xùn)學(xué)校>廣州市天河區(qū)達(dá)內(nèi)IT培訓(xùn)
廣州市天河區(qū)達(dá)內(nèi)IT培訓(xùn)
全國統(tǒng)一學(xué)習(xí)專線 8:30-21:00
位置:魔方格 > 計(jì)算機(jī)>Java開發(fā)> Java注釋類型有哪些呢?  正文

Java注釋類型有哪些呢?

發(fā)布時(shí)間:2022-03-12 14:22:34來源:魔方格

Java中注釋有兩種類型:程序注釋和文檔注釋。程序注釋是對程序某個(gè)部分的具體實(shí)現(xiàn)的注釋;文檔注釋是對程序的描述性注釋,主要是為那些不需要知道程序的具體實(shí)現(xiàn)的開發(fā)者提供的。

Java提供有兩種類型的注釋:程序注釋和文檔注釋。

程序注釋是由分隔符/*···*/和//隔開的部分,這些注釋與C++中的注釋相同。文檔注釋是Java所特有的,由分隔符/**···*/隔開,文檔注釋可以用javadoc工具提取出來,形成HTML文件。

程序注釋是對程序某個(gè)部分的具體實(shí)現(xiàn)的注釋;文檔注釋是對程序的描述性注釋,主要是為那些不需要知道程序的具體實(shí)現(xiàn)的開發(fā)者提供的。注釋中可以描述一些精妙的算法和一些不容易理解的設(shè)計(jì)思想。

但應(yīng)該避免那些在程序代碼中很清楚地表達(dá)出來的信息。盡可能地避免過時(shí)的信息,錯(cuò)誤的注釋比沒有注釋更有害,經(jīng)常性的注釋有時(shí)也反映出代碼質(zhì)量的低下。

程序注釋有四種類型:塊注釋、單行注釋、跟隨注釋和行尾注釋。

(1)塊注釋:主要用于描述文件、方法、數(shù)據(jù)結(jié)構(gòu)和算法。它通常用在文件或方法定義之前,也可以用在方法定義里面,此時(shí)它的縮進(jìn)必須與它所描述的代碼相同。

塊注釋應(yīng)該以空行開始,以便于區(qū)分代碼的各個(gè)部分。

2、單行注釋:一個(gè)相對較短的注釋可以放在單行上,但必須與它后面的代碼有相同的縮進(jìn)。如果注釋不適合放在一行,那么它必須用塊注釋的格式來寫。

3、跟隨注釋:一個(gè)非常短的注釋可以和它所描述的代碼放在同一行,但要確保代碼和注釋之間有足夠的間距。如果在同一個(gè)代碼塊中有多個(gè)這樣的注釋,它們應(yīng)該是對齊的。

4、行尾注釋。行尾注釋不能用于多行文本注釋,但可以對多行代碼進(jìn)行注釋。注釋標(biāo)記"//"可以注釋一行或以"//"開始的部分,直到該行的結(jié)束。

文檔注釋描述了Java類、接口、構(gòu)造函數(shù)等。每個(gè)類、接口或成員在聲明它的地方之前只有一個(gè)文檔注釋。較外層的類或接口的文檔注釋是不縮進(jìn)的,但其成員的文檔注釋的縮進(jìn)格式與成員的聲明相同。

相關(guān)內(nèi)容: Java Java注釋 Java注釋類型

相關(guān)文章
最新文章
相關(guān)熱詞