程式註解的常用標記

• TODO
• FIXME
• XXX
• NOTE
• HACK

TODO

• 需要實作的部份
  • Bug, 錯誤, 改進等都不是TODO，見下述標籤

FIXME

• 錯誤的、需要修正的部份
• 相似的標記: BUG
  • FIXME 解釋如何修正錯誤
  • BUG 記錄如何使錯誤發生

XXX

• 需要改進的實作方式
• 相似的標記: REFACT
  • 想重構時可用

NOTE

• 說明程式碼的如何使用
  • 就是註解原本的用途
  • 所以實際上不用加NOTE，直接寫也可以
• 相似的標記: MARK

HACK

• 一個暫時、骯髒的解法
• 不應該進commit

使用

• VSCode 中的套件
  • TODO tree
• 除了標記，還需要說明文字，多人協作時也可署名
• 範例
  • ❌TODO:
  • ⭕TODO: lowercase
  • ⭕TODO(qwerty): lowercase
• 有些標記不需要寫在程式碼中，而是放在專案管理中
  • BUG：應記錄在Bug tracker
  • TODO：應記錄在Todo tracker

參考資料

The art of readable code