寫(xiě)注釋如果方法不對(duì)，是比沒(méi)寫(xiě)還惡劣的行為!

　　我想到的，常見(jiàn)的情況有：

　　1. 注釋不規(guī)范或過(guò)度注釋

　　隨意的，到處都是注釋，有用沒(méi)用的都寫(xiě)，比如：

　　a = 1; // 給 a 賦值為1

　　誰(shuí)還看不懂 a=1 是做啥么...

　　2. 注釋不維護(hù)

　　業(yè)務(wù)變化比較快的系統(tǒng)，需要連續(xù)不斷的開(kāi)發(fā)，你要一直對(duì)它做維護(hù)性質(zhì)的開(kāi)發(fā)，有時(shí)候要不斷的修改代碼以適應(yīng)業(yè)務(wù)的變化。這時(shí)候問(wèn)題就來(lái)了。。

　　比如某個(gè)函數(shù)一開(kāi)始是做A這件事，第一個(gè)人為這個(gè)函數(shù)寫(xiě)了注釋是A，后來(lái)業(yè)務(wù)變化，第二個(gè)人把這個(gè)函數(shù)改成做B這件事了，然后測(cè)試通過(guò)，沒(méi)問(wèn)題了。此時(shí)注釋還是A. 后來(lái)第三個(gè)人改成了做C，注釋仍然是A。

　　函數(shù)的功能可測(cè)，但是注釋不可測(cè)，注釋需要人的維護(hù)，如果不維護(hù)簡(jiǎn)直就是噩夢(mèng)。

　　假設(shè)有第四個(gè)人過(guò)來(lái)讀代碼，看到注釋都是A的內(nèi)容，他是不是會(huì)一頭霧水呢?

　　有些注釋，有人認(rèn)為很有用，但我覺(jué)得在這種場(chǎng)景下不一定。

　　比如有人喜歡 @ xxx 在函數(shù)或者類(lèi)的前邊標(biāo)記自己的大名，我就覺(jué)得這個(gè)做法在多人、業(yè)務(wù)變化的開(kāi)發(fā)場(chǎng)景下，很雞肋。通常人家把你的代碼改得面目全非了，看作者還是你，今后出了問(wèn)題，后來(lái)人詛咒的是你這個(gè) xxx 啊....

　　3. 代碼只注釋，不刪除

　　很多人寫(xiě)代碼總有這種習(xí)慣，一段代碼不用了，注釋掉，心里總想著這段代碼以后可能還會(huì)用。但大多數(shù)情況下，過(guò)幾天就忘了，結(jié)果代碼里到處都是“注釋”，沒(méi)有一句是有用的。讀代碼的人也不敢刪，一直留著留著。