小編先說一件真事，以前在公司的時(shí)候，有一位技術(shù)非常牛逼的前輩，在代碼注釋中寫了“說了你也聽不懂！垃圾”，這不是重點(diǎn)，重點(diǎn)是他下意識的把這句話復(fù)制到了彈框提示的文字中，用來測試一個(gè)代碼的邏輯性，后來忘了刪除。代碼也提交到了測試部，巧的是在bug系統(tǒng)發(fā)現(xiàn)了這個(gè)bug，bug彈出了“說了你也聽不懂！垃圾”，最后被測試部的大佬邀請喝公辦茶。

個(gè)人觀點(diǎn)，只是經(jīng)驗(yàn)之談，歡迎來噴?！

1、在類級別，方法級別上最好加上注釋。

特別是那些邏輯復(fù)雜的，難以用一句話描述清楚的內(nèi)容，最好加上注釋。這個(gè)注釋很重要，特別是這些代碼還要被其他人使用的時(shí)候，加上說明會方便很多。

2、在某些容易留坑的地方，最好加上注釋。

這種地方很多時(shí)候是因?yàn)閳D省事，或者沒時(shí)間等原因，只能暫時(shí)這么做，但是需要提醒使用者注意?；蛘邞岩申?duì)友水平?jīng)]那么高，理解不了你的代碼，某天來修改代碼并且容易改錯(cuò)?；蛘呤且?yàn)檫@段代碼『特立獨(dú)行』，不是按照常規(guī)方式，你自己在這里耍了小聰明，或者用了自己設(shè)計(jì)的一些技巧性的東西，怕別人看不懂。

3、涉及到業(yè)務(wù)邏輯的代碼，比如某些字段需要加說明，之類的。

有些業(yè)務(wù)的東西，確實(shí)不是一兩句代碼就能扯清楚的，這種東西，加個(gè)注釋就好了。

4、因?yàn)樾迯?fù)某個(gè)bug而加進(jìn)去的代碼。

改bug，特別是改別人的bug的時(shí)候，如果不是進(jìn)行大規(guī)模的重構(gòu)，而是往里面加小段代碼打補(bǔ)丁的時(shí)候，最好加上注釋，否則這段代碼很奇怪，并且容易看不懂。記住最好留上你的名字，不然后人看這個(gè)代碼都不知道該去罵誰。

最后，給大家推薦一個(gè)**Java進(jìn)階內(nèi)推交流群730379855**，不管你在地球哪個(gè)方位，不管你參加工作幾年都?xì)g迎你的入駐！（群內(nèi)會免費(fèi)提供一些群主收藏的免費(fèi)學(xué)習(xí)書籍資料以及整理好的幾百道面試題和答案文檔！）