《代碼整潔之道》筆記03——註釋

註釋是在代碼表達意圖時遭遇的失敗。

註釋不能美化糟糕的代碼

用代碼來闡述

好註釋

  1. 法律信息
  2. 對基本信息的註釋
  3. 對意圖的解釋
  4. 闡釋
  5. 警示
  6. TODO註釋,程序員認爲應該去做,但是由於一些原因沒用實現完的註釋。
  7. 放大不合理之物的重要性
  8. 公共API描述

壞註釋

  1. 喃喃自語/廢話註釋
  2. 多餘的註釋
  3. 誤導性註釋
  4. 循規式註釋:不需要給每一個函數進行註釋
  5. 日誌式註釋
  6. 能用函數和變量時就別用註釋
  7. 用於位置標識的註釋
  8. 註釋的代碼
  9. 信息過多
  10. 不明顯的聯繫
發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章