這個藉口最有道理。

一個事實#

每位開發者都看過毫無用處的註解,現存大部分文件頂多差強人意

但問題可解#

寫好的文件並不困難——只要你知道方法。

接下來幾章會給出寫好註解的框架,並討論如何隨時間維護它們:

  • 第 13 章:怎麼寫
  • 第 14 章:好的命名(減少對註解的依賴)
  • 第 15 章:先寫註解作為設計工具
  • 第 16 章:修改既有程式碼時的文件維護

別讓「過去看過爛註解」這個經驗成為你寫不出好註解的藉口。