報道公司事件 · 傳播行業動態
寫注釋如果方法不對,是比沒寫還惡劣的行為!
我想到的,常見的情況有:
1. 注釋不規范或過度注釋
隨意的,到處都是注釋,有用沒用的都寫,比如:
a = 1; // 給 a 賦值為1
誰還看不懂 a=1 是做啥么...
2. 注釋不維護
業務變化比較快的系統,需要連續不斷的開發,你要一直對它做維護性質的開發,有時候要不斷的修改代碼以適應業務的變化。這時候問題就來了。。
比如某個函數一開始是做A這件事,第一個人為這個函數寫了注釋是A,后來業務變化,第二個人把這個函數改成做B這件事了,然后測試通過,沒問題了。此時注釋還是A. 后來第三個人改成了做C,注釋仍然是A。
函數的功能可測,但是注釋不可測,注釋需要人的維護,如果不維護簡直就是噩夢。
假設有第四個人過來讀代碼,看到注釋都是A的內容,他是不是會一頭霧水呢?
有些注釋,有人認為很有用,但我覺得在這種場景下不一定。
比如有人喜歡 @ xxx 在函數或者類的前邊標記自己的大名,我就覺得這個做法在多人、業務變化的開發場景下,很雞肋。通常人家把你的代碼改得面目全非了,看作者還是你,今后出了問題,后來人詛咒的是你這個 xxx 啊....
3. 代碼只注釋,不刪除
很多人寫代碼總有這種習慣,一段代碼不用了,注釋掉,心里總想著這段代碼以后可能還會用。但大多數情況下,過幾天就忘了,結果代碼里到處都是“注釋”,沒有一句是有用的。讀代碼的人也不敢刪,一直留著留著。