寫注釋如果方法不對，是比沒寫還(hái)惡劣的行(xíng)為(wèi)!
我想到的，常見的情況有(yǒu)：
1. 注釋不規範或過度注釋
随意的，到處都是注釋，有(yǒu)用沒用的都寫，比如：
a = 1; // 給 a 賦值為(wèi)1
誰還(hái)看不懂 a=1 是做(zuò)啥麽...
2. 注釋不維護
業務變化比較快的系統，需要連續不斷的開(kāi)發，你(nǐ)要一直對它做(zuò)維護性質的開(kāi)發，有(yǒu)時(shí)候要不斷的修改代碼以适應業務的變化。這時(shí)候問題就來(lái)了。。
比如某個(gè)函數(shù)一開(kāi)始是做(zuò)A這件事，第一個(gè)人(rén)為(wèi)這個(gè)函數(shù)寫了注釋是A，後來(lái)業務變化，第二個(gè)人(rén)把這個(gè)函數(shù)改成做(zuò)B這件事了，然後測試通(tōng)過，沒問題了。此時(shí)注釋還(hái)是A. 後來(lái)第三個(gè)人(rén)改成了做(zuò)C，注釋仍然是A。
函數(shù)的功能可(kě)測，但(dàn)是注釋不可(kě)測，注釋需要人(rén)的維護，如果不維護簡直就是噩夢。
假設有(yǒu)第四個(gè)人(rén)過來(lái)讀代碼，看到注釋都是A的內(nèi)容，他是不是會(huì)一頭霧水(shuǐ)呢?
有(yǒu)些(xiē)注釋，有(yǒu)人(rén)認為(wèi)很(hěn)有(yǒu)用，但(dàn)我覺得(de)在這種場(chǎng)景下不一定。
比如有(yǒu)人(rén)喜歡 @ xxx 在函數(shù)或者類的前邊标記自己的大(dà)名，我就覺得(de)這個(gè)做(zuò)法在多(duō)人(rén)、業務變化的開(kāi)發場(chǎng)景下，很(hěn)雞肋。通(tōng)常人(rén)家(jiā)把你(nǐ)的代碼改得(de)面目全非了，看作(zuò)者還(hái)是你(nǐ)，今後出了問題，後來(lái)人(rén)詛咒的是你(nǐ)這個(gè) xxx 啊....
3. 代碼隻注釋，不删除
很(hěn)多(duō)人(rén)寫代碼總有(yǒu)這種習慣，一段代碼不用了，注釋掉，心裏總想着這段代碼以後可(kě)能還(hái)會(huì)用。但(dàn)大(dà)多(duō)數(shù)情況下，過幾天就忘了，結果代碼裏到處都是“注釋”，沒有(yǒu)一句是有(yǒu)用的。讀代碼的人(rén)也不敢删，一直留着留着。
