旗下網站

百科知識庫

報道公司事件 · 傳播行業動态

寫代碼時(Hour)注意規範

發布日期:2015-01-08    發布者:吳彬彬

  寫注釋如果方法不(No)對,是比沒寫還惡劣的(Of)行爲(For)!

  我(I)想到(Arrive)的(Of),常見的(Of)情況有:

  1. 注釋不(No)規範或過度注釋

  随意的(Of),到(Arrive)處都是注釋,有用(Use)沒用(Use)的(Of)都寫,比如:

  a = 1; // 給 a 賦值爲(For)1

  誰還看不(No)懂 a=1 是做啥麽...

  2. 注釋不(No)維護

  業務變化比較快的(Of)系統,需要(Want)連續不(No)斷的(Of)開發,你要(Want)一(One)直對它做維護性質的(Of)開發,有時(Hour)候要(Want)不(No)斷的(Of)修改代碼以(By)适應業務的(Of)變化。這(This)時(Hour)候問題就來(Come)了。。

  比如某個(Indivual)函數一(One)開始是做A這(This)件事,第一(One)個(Indivual)人(People)爲(For)這(This)個(Indivual)函數寫了注釋是A,後來(Come)業務變化,第二個(Indivual)人(People)把這(This)個(Indivual)函數改成做B這(This)件事了,然後測試通過,沒問題了。此時(Hour)注釋還是A. 後來(Come)第三個(Indivual)人(People)改成了做C,注釋仍然是A。

  函數的(Of)功能可測,但是注釋不(No)可測,注釋需要(Want)人(People)的(Of)維護,如果不(No)維護簡直就是噩夢。

  假設有第四個(Indivual)人(People)過來(Come)讀代碼,看到(Arrive)注釋都是A的(Of)内容,他(He)是不(No)是會一(One)頭霧水呢?

  有些注釋,有人(People)認爲(For)很有用(Use),但我(I)覺得在(Exist)這(This)種場景下不(No)一(One)定。

  比如有人(People)喜歡 @ xxx 在(Exist)函數或者類的(Of)前邊标記自己的(Of)大(Big)名,我(I)就覺得這(This)個(Indivual)做法在(Exist)多人(People)、業務變化的(Of)開發場景下,很雞肋。通常人(People)家把你的(Of)代碼改得面目全非了,看作(Do)者還是你,今後出(Out)了問題,後來(Come)人(People)詛咒的(Of)是你這(This)個(Indivual) xxx 啊....

  3. 代碼隻注釋,不(No)删除

  很多人(People)寫代碼總有這(This)種習慣,一(One)段代碼不(No)用(Use)了,注釋掉,心裏總想着這(This)段代碼以(By)後可能還會用(Use)。但大(Big)多數情況下,過幾天就忘了,結果代碼裏到(Arrive)處都是“注釋”,沒有一(One)句是有用(Use)的(Of)。讀代碼的(Of)人(People)也不(No)敢删,一(One)直留着留着。

Copyright 大(Big)連網龍科技 版權所有 京ICP證000000号  html - txt -

遼公網安備 21021702000140号

電話
客服