特殊註解:TODO、FIXME、XXX

最早接觸到這些特殊註解是在寫 Eclipse 的時候,有些自動產生的程式碼就會自己補上 //TODO,在 Tasks 分頁就能顯示出這些備註,點擊就直接跳到程式碼上相當方便。

實際上在 Preferences > Java > Compiler > Task Tags 下可以看到預設只支援 TODO、FIXME 和 XXX 這三種特殊註釋。

除了 TODO、FIXME 和 XXX 外,我也列出了我比較少用,但在其他地方有看到的特殊註釋:

  • TODO:知道要實作什麼功能,但還沒開始寫的程式碼。比如://TODO 接上 LDAP 認證
  • FIXME:發現比較少發生的 bug,但當下沒時間改。比如://FIXME 對方回傳結果缺乏 foo 欄位,會造成 NullPointerException。
  • XXX:很醜但可以正常運作的程式碼,我會先用這個註釋標註,未來有空回來優化。比如://XXX 目前用 iterator 的方式掃描集合,可改用 Stream 的方式。
  • 少用
    • NOTE:說明這段程式碼怎麼運作。因為等於在寫一般的單行註解,所以我沒用過。
    • HACK:這裡用非正規的方法實作功能(Android 開發常用 reflection 機制呼叫沒開放的功能)。因為跟 XXX 類似,所以我很少用。
    • BUG:這裡有 bug。因為跟 FIXME 類似,所以我很少用。

0 則回應: