註解確實會過時——但這在實務上不該成為大問題。

為什麼維護註解不會吃掉太多時間#

  • 大規模文件變更只在程式碼大幅變動時才需要
  • 而程式碼變動本身就會比文件變動花更多時間
  • 因此文件維護的成本只是程式碼變動成本的一小部分

怎麼讓文件容易維護#

第 16 章會詳細討論。兩個關鍵想法:

  • 避免重複文件(duplicated documentation)
  • 讓文件貼近相關程式碼(near the code)

程式碼審查(Code Review)的角色#

程式碼審查是偵測與修正過時註解的好機制。

讓「審查時順便檢查註解」成為團隊習慣,過時問題會自然控制。