TODO
FIXME
- 錯誤的、需要修正的部份
- 相似的標記:
BUG
FIXME
解釋如何修正BUG
記錄錯誤如何發生
XXX
- 需要改進的實作方式
- 相似的標記:
REFACT
- 想重構時可用
NOTE
- 說明程式碼的用途
- 即註解原本的用途
- 相似的標記:
MARK
HACK
- 一個暫時、骯髒的解法
- 不應該進commit
使用
- VS Code 中的套件
- TODO tree
- 除了標記,還需要說明文字
- 範例
TODO: lowercase
- 有些標記不應該寫在程式碼中
BUG
:應該有專用的bug trackerTODO
:應記錄在Todo tracker
reference
- The art of readable code