副標:The Four Excuses(避寫註解的四種藉口)

註解的真正角色

  • 幫助開發者理解系統、提高效率
  • 抽象的關鍵:沒有註解,就無法藏起複雜性
  • 寫註解的過程本身會改善設計

反之:好設計若文件不佳,價值就大打折扣。

現況#

可惜這個觀點並未被普遍接受:

  • 大量正式程式碼幾乎沒有註解
  • 不少開發者覺得寫註解是浪費時間
  • 即使有人認可註解的價值,也常拖著不寫
  • 在重視文件的團隊中,註解仍常被當作苦工,多數人也不知怎麼寫

本章脈絡#

開發者不寫註解時的常見藉口:

  1. 好程式自己會說話
  2. 我沒時間寫
  3. 註解會過時、誤導讀者
  4. 我看過的註解都沒用

接下來各節逐一回應,並在最後說明寫得好的註解能帶來什麼好處。

重要訊息#

三件事希望你能被說服:

  1. 好的註解會大幅改變軟體整體品質
  2. 寫好的註解並不困難
  3. 寫註解其實可以很有趣(這點可能最難相信)