試想一下,一個(gè)沒(méi)有一句注釋的程序源碼,怎么讀,一個(gè)程序要上萬(wàn)條代碼不可能全部記得住哪一塊是什么用,而且一個(gè)項(xiàng)目也不會(huì)是一個(gè)人獨(dú)自完成,那樣效率太低,多人合作就要給別人說(shuō)明,每一塊是什么用,方便他人使用,方便自己更正,而這些說(shuō)明文字就是注釋,注釋不會(huì)被執(zhí)行,不影響運(yùn)行結(jié)果。
東風(fēng)ssl適用于網(wǎng)站、小程序/APP、API接口等需要進(jìn)行數(shù)據(jù)傳輸應(yīng)用場(chǎng)景,ssl證書(shū)未來(lái)市場(chǎng)廣闊!成為創(chuàng)新互聯(lián)建站的ssl證書(shū)銷售渠道,可以享受市場(chǎng)價(jià)格4-6折優(yōu)惠!如果有意向歡迎電話聯(lián)系或者加微信:028-86922220(備注:SSL證書(shū)合作)期待與您的合作!
Java中代碼的注釋有三種:
// 注釋一行?
/* ...... */ 注釋若干行?
/** ...... */ 注釋若干行,并寫(xiě)入 javadoc 文檔
前兩種比較容易理解,至于第三種,你學(xué)習(xí)Java看的api文檔就是javadoc程序根據(jù)第三種的注釋生成的。
擴(kuò)展資料
注釋就是對(duì)代碼的解釋和說(shuō)明,其目的是讓人們能夠更加輕松地了解代碼。注釋是編寫(xiě)程序時(shí),寫(xiě)程序的人給一個(gè)語(yǔ)句、程序段、函數(shù)等的解釋或提示,能提高程序代碼的可讀性。
1、單行(single-line)--短注釋://…… 單獨(dú)行注釋:在代碼中單起一行注釋, 注釋前最好有一行空行,并與其后的代碼具有一樣的縮進(jìn)層級(jí)。如果單行無(wú)法完成,則應(yīng)采用塊注釋。 注釋格式:/* 注釋內(nèi)容 */ 行頭注釋:在代碼行的開(kāi)頭進(jìn)行注釋。主要為了使該行代碼失去意義。 注釋格式:// 注釋內(nèi)容 行尾注釋:尾端(trailing)--極短的注釋,在代碼行的行尾進(jìn)行注釋。一般與代碼行后空8(至少4)個(gè)格,所有注釋必須對(duì)齊。 注釋格式:代碼 + 8(至少4)個(gè)空格 + // 注釋內(nèi)容 2、塊(block)--塊注釋:/*……*/ 注釋若干行,通常用于提供文件、方法、數(shù)據(jù)結(jié)構(gòu)等的意義與用途的說(shuō)明,或者算法的描述。一般位于一個(gè)文件或者一個(gè)方法的前面,起到引導(dǎo)的作用,也可以根據(jù)需要放在合適的位置。這種域注釋不會(huì)出現(xiàn)在HTML報(bào)告中。注釋格式通常寫(xiě)成: /* * 注釋內(nèi)容 */ 3、文檔注釋:/**……*/ 注釋若干行,并寫(xiě)入javadoc文檔。每個(gè)文檔注釋都會(huì)被置于注釋定界符 /**......*/ ...
寫(xiě)代碼的時(shí)候,有時(shí)候,你需要寫(xiě)一些注釋,把內(nèi)容相互關(guān)聯(lián)起來(lái),方便自己或別人看的時(shí)候,可以直接找到你關(guān)聯(lián)的代碼類或者啥的。
這個(gè)時(shí)候,{@link}與@see,這2個(gè)javadoc注解就派上用場(chǎng)了,
不管他具體有什么功能,咱就只管一個(gè),他可以鏈接代碼,讓注釋看的更清楚易懂。方便你我他。
@see 標(biāo)簽允許用戶引用其他類的文檔。具體使用方式如下:
@see classname
@see fully-qualified-classname
@see fully-qualified-classname#方法名稱
@see fully-qualified-classname#屬性名稱
我在使用的時(shí)候,發(fā)現(xiàn)這個(gè)只能單獨(dú)一行頂頭寫(xiě),如果不頂頭寫(xiě)就不管用了,沒(méi)了鏈接的效果。
但是,{@link}這個(gè)卻可以隨便放。
具體使用方法和上面那個(gè)@see是一樣的。
實(shí)際效果,看下面的圖
文章題目:java代碼注釋不會(huì)寫(xiě) java代碼注釋不會(huì)寫(xiě)了
文章網(wǎng)址:http://sd-ha.com/article30/hheiso.html
成都網(wǎng)站建設(shè)公司_創(chuàng)新互聯(lián),為您提供微信小程序、網(wǎng)頁(yè)設(shè)計(jì)公司、品牌網(wǎng)站設(shè)計(jì)、Google、軟件開(kāi)發(fā)、定制網(wǎng)站
聲明:本網(wǎng)站發(fā)布的內(nèi)容(圖片、視頻和文字)以用戶投稿、用戶轉(zhuǎn)載內(nèi)容為主,如果涉及侵權(quán)請(qǐng)盡快告知,我們將會(huì)在第一時(shí)間刪除。文章觀點(diǎn)不代表本網(wǎng)站立場(chǎng),如需處理請(qǐng)聯(lián)系客服。電話:028-86922220;郵箱:631063699@qq.com。內(nèi)容未經(jīng)允許不得轉(zhuǎn)載,或轉(zhuǎn)載時(shí)需注明來(lái)源: 創(chuàng)新互聯(lián)