1.添加注釋的位置

　　(1)類，接口

　　這一部分注釋是必須的。在這里，我們需要使用javadoc注釋，需要標(biāo)明，創(chuàng)建者，創(chuàng)建時(shí)間，版本，以及該類的作用。

　　(2)方法

　　在方法中，我們需要對(duì)入?yún)ⅲ鰠?，以及返回值，均要?biāo)明。

　　(3)常量

　　對(duì)常量，我們需要使用多行注釋，進(jìn)行標(biāo)明該常量的用途，如下所示:

　　(4)關(guān)鍵算法上

　　在關(guān)鍵算法上，添加注釋并且按照順序依次標(biāo)明，寫明白該方法為什么這么做。

　　2.添加注釋的原則

　　(1)注釋形式統(tǒng)一

　　在整個(gè)應(yīng)用程序中，使用具有一致的標(biāo)點(diǎn)和結(jié)構(gòu)的樣式來構(gòu)造注釋。如果在其它項(xiàng)目中發(fā)現(xiàn)它們的注釋規(guī)范與這份文檔不同，按照這份規(guī)范寫代碼，不要試圖在既成的規(guī)范系統(tǒng)中引入新的規(guī)范。

　　(2)注釋內(nèi)容準(zhǔn)確簡(jiǎn)潔

　　內(nèi)容要簡(jiǎn)單、明了、含義準(zhǔn)確，防止注釋的多義性，錯(cuò)誤的注釋不但無益反而有害。

　　在之前的文章中學(xué)習(xí)了不少關(guān)于java注釋的方式以及快捷操作，有些人還不清楚應(yīng)該注釋的位置，以及注釋時(shí)需要注意的原則。注釋位置為類，接口、方法、常量、關(guān)鍵算法，原則有注釋形式統(tǒng)一和注釋內(nèi)容準(zhǔn)確簡(jiǎn)潔。以上就是我們?cè)贘ava基礎(chǔ)中注釋添加位置以及原則的詳解，學(xué)會(huì)了的小伙伴在使用java注釋時(shí)一定要時(shí)時(shí)牢記，本篇內(nèi)容到這里就結(jié)束啦。

　　推薦操作環(huán)境：windows7系統(tǒng)、java10版，DELL G3電腦。

　　更多關(guān)于“Java培訓(xùn)”的問題，歡迎咨詢千鋒教育在線名師。千鋒已有十余年的培訓(xùn)經(jīng)驗(yàn)，課程大綱更科學(xué)更專業(yè)，有針對(duì)零基礎(chǔ)的就業(yè)班，有針對(duì)想提升技術(shù)的好程序員班，高品質(zhì)課程助力你實(shí)現(xiàn)java程序員夢(mèng)想。