日誌型註解

日誌型註解

日誌型註解

日誌型註解

以前,工程師在開始編輯程式碼時,都會在模組的開頭
加上一條註解。這些註解累積久了,便形成每次修改程式
的日記或日誌。

  • Changes (from 11-Oct-2001)
  • 11-Oct-2001 : aaa
  • 05-Nov-2001 : bbb
  • 12-Nov-2001 : ccc

在很久以前因沒有程式碼管控系統,所以有很好的理由,
在每個模組開頭產生和維護這樣的日誌項目。但如今,
這些又臭又長的日誌,只會使得模組更加雜亂和混淆,
它們應該徹底被移除掉。