用來與「未來的自己」對話,適用於程式碼、筆記、技術草稿、研究流程等 只要能在文件中標注,就能建立跨時間的高效知識管理系統。
✅ 標準通用 Tag
Tag | 意圖說明 | 常見場景 |
---|---|---|
|
尚未完成的功能或工作,需後續補上 |
新增功能、加註說明、補測試 |
|
明確已知的錯誤,需要修正 |
錯誤邏輯、錯誤資料處理 |
|
備註補充,說明非直覺之處或特例 |
系統限制、潔規則備忘 |
|
臨時修補方案,設計不佳但先可用 |
workaround、跨版本相容 |
|
技術性或外部限制下的解法 |
第三方問題、硬體限制 |
|
高風險或需要特別注意的區域 |
潔性副作用、資料破壞風險 |
|
已知 bug,應記錄與追蹤 |
已報 issue、已知重現路徑 |
|
已棄用但仍存在的功能,不建議使用 |
舊 API、未來將移除功能 |
|
可優化的部分(效能、結構) |
資料排序、重複計算、資源配置 |
|
需要他人或自己重新檢視的區段 |
程式邏輯、架構設計判斷 |
📂 協作與暫存類 Tag
Tag | 意圖說明 | 常見場景 |
---|---|---|
|
暫時存在的程式碼,緩後刪除 |
調試中 debug code、測試用值 |
|
有疑問尚未確認的地方 |
不確定邏輯、規格落差 |
|
建議與他人共同討論的區段 |
設計選擇、API 命名方向 |
|
特意這樣寫的設計(防止他人誤改) |
明知效能差但有理由 |
|
使用上的注意事項、限制說明 |
僅適用某平台、需要某前提 |
|
目前未用但保留觀察 |
舊邏輯、預留代碼 |
🔍 使用小技巧
- 可加上作者與時間,例如:
// TODO(@Lyra): 完成 refactoring, 2025-06-10
- 搭配 issue 編號追蹤:
# FIXME: see issue #128 for null pointer case
- 多數 IDE / text editor 可自動收集
TODO
,FIXME
等標籤並顯示於 side panel - 在 Markdown 筆記或 Jupyter Notebook 中一樣適用:
<!-- NOTE: 這裡的日文語尾為特例,之後補文法筆記 -->
🌱 建議內化順序(新手 → 進階)
TODO:
/FIXME:
→ 最常用、即時導向的任務管理NOTE:
/HACK:
/BUG:
→ 支援背景說明與例外處理OPTIMIZE:
/DEPRECATED:
→ 進階程式可讀性與長期維護- 其餘標籤可視需減陷慮後慢慢加進工作流中