建議152:最少,甚至是不要註釋
以往,我們在代碼中不寫上幾行註釋,就會被認爲是鐘不負責任的態度。現在,這種觀點正在改變。試想,如果我們所有的命名全部採用有意義的單詞或詞組,註釋還有多少存在的價值。
即便再詳細的註釋也不能優化糟糕的代碼。並且註釋往往不會隨着代碼的重構自動更新,有時候我們可能會在修改代碼後忘記更新那段用來表達最初意圖的文字了。所以,儘量拋棄註釋吧,除非我們覺得只有良好的代碼邏輯和命名仍舊不足以表達意圖。
當然,有些註釋可能不得不加,如一些版權信息。另外,如果我們正在開發公共API,保持一份良好的嚴格按照格式要求所寫的註釋有利於生成API參考手冊。
當前有一種主張:不要寫註釋,或者儘量保持最少註釋。
但前提是所有的命名全部採用有意義的單詞或詞組。
轉自:《編寫高質量代碼改善C#程序的157個建議》陸敏技