程序員應該避免的5種代碼註釋

你有沒有這樣的經歷：別人審查過你的代碼以後給出的註釋，你認爲是沒有必要的？註釋代碼是爲了提升代碼的可讀性，目的是爲了能讓其餘人更容易理解你的代碼。

我特別討厭這5種註釋類型以及製造它們的程序員。但願你不是其中之一。更多精彩文章盡在愛開發APP源碼論壇

1.自覺得很了不起的程序員

 

這個程序員自認爲寫了一段很了不起的代碼，因此以爲有必要用本身的名字對每行代碼進行標記。實施版本控制系統（VCS）能實現對代碼變動的問責，可是也不會這麼明顯知道誰應對此負責。

 

 

2.過期的程序員

若是一段代碼已再也不使用（即過期），那就刪除它——不要浪費時間給這些代碼寫註釋。此外，若是你須要複製這段被刪除的代碼，別忘了還有版本控制系統，你徹底能夠從早期的版本中恢復代碼。

 

 

3.畫蛇添足的程序員

咱們都知道基礎的編程邏輯是如何工做的——因此你不須要畫蛇添足來解釋這些顯而易見的工做原理，雖說你解釋得很happy，但這只是在浪費時間和空間。

 

 

4.愛講故事的程序員

若是你必定要在註釋裏說起需求，那麼不要涉及別人的名字。銷售部門的Jim可能會離開公司，並且頗有可能大多數程序員根本不知道這是何許人也。不要在註釋裏說起不相干的事實。

 

 

5.「之後再作」的程序員

這種類型的註釋包含了上面全部其餘類型。若是是在項目的初始開發階段，這種待作註釋是很是有用的，但若是是在幾年後的產品代碼——那就會出問題了。若是有什麼須要修復的，立馬解決，不要把它擱置一邊，「之後再作」。

若是你也經常犯這樣的註釋錯誤，若是你想了解註釋的最佳作法，我建議你閱讀相似於Steve McConnell寫的《Code Complete》這樣的好書。

另外筆者也推薦你閱讀如下內容：《9個最有趣的代碼註釋》、《代碼註釋中的5要與3不要》