寫代碼時(shí)注意規範

　　寫注釋如果方法不對(duì)，是比沒寫還(hái)惡劣的(de)行爲!

　　我想到的(de)，常見的(de)情況有：

　　1. 注釋不規範或過度注釋

　　随意的(de)，到處都是注釋，有用(yòng)沒用(yòng)的(de)都寫，比如：

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

　　誰還(hái)看不懂(dǒng) a=1 是做(zuò)啥麽...

　　2. 注釋不維護

　　業務變化(huà)比較快(kuài)的(de)系統，需要連續不斷的(de)開發，你要一直對(duì)它做(zuò)維護性質的(de)開發，有時(shí)候要不斷的(de)修改代碼以适應業務的(de)變化(huà)。這(zhè)時(shí)候問題就來(lái)了(le)。。

　　比如某個(gè)函數一開始是做(zuò)A這(zhè)件事，第一個(gè)人(rén)爲這(zhè)個(gè)函數寫了(le)注釋是A，後來(lái)業務變化(huà)，第二個(gè)人(rén)把這(zhè)個(gè)函數改成做(zuò)B這(zhè)件事了(le)，然後測試通(tōng)過，沒問題了(le)。此時(shí)注釋還(hái)是A. 後來(lái)第三個(gè)人(rén)改成了(le)做(zuò)C，注釋仍然是A。

　　函數的(de)功能可(kě)測，但是注釋不可(kě)測，注釋需要人(rén)的(de)維護，如果不維護簡直就是噩夢。

　　假設有第四個(gè)人(rén)過來(lái)讀代碼，看到注釋都是A的(de)内容，他(tā)是不是會一頭霧水(shuǐ)呢(ne)?

　　有些注釋，有人(rén)認爲很有用(yòng)，但我覺得(de)在這(zhè)種場(chǎng)景下(xià)不一定。

　　比如有人(rén)喜歡 @ xxx 在函數或者類的(de)前邊标記自己的(de)大(dà)名，我就覺得(de)這(zhè)個(gè)做(zuò)法在多(duō)人(rén)、業務變化(huà)的(de)開發場(chǎng)景下(xià)，很雞肋。通(tōng)常人(rén)家把你的(de)代碼改得(de)面目全非了(le)，看作者還(hái)是你，今後出了(le)問題，後來(lái)人(rén)詛咒的(de)是你這(zhè)個(gè) xxx 啊....

　　3. 代碼隻注釋，不删除

　　很多(duō)人(rén)寫代碼總有這(zhè)種習(xí)慣，一段代碼不用(yòng)了(le)，注釋掉，心裏總想著(zhe)這(zhè)段代碼以後可(kě)能還(hái)會用(yòng)。但大(dà)多(duō)數情況下(xià)，過幾天就忘了(le)，結果代碼裏到處都是“注釋”，沒有一句是有用(yòng)的(de)。讀代碼的(de)人(rén)也(yě)不敢删，一直留著(zhe)留著(zhe)。