前言
有時,您需要標記部分代碼以供將來參考,比如: 優化,改進,可能的更改,要討論的問題等。 通常我們會在代碼中加入如下的標記表示待辦:
<code>//TODO 我將要在這裡做 xxx/<code>
你這樣做,別人也會這樣做。一時間,項目中可能會存在大量的 TODO,當你搜尋你的 TODO 時也就變得非常麻煩,如同石沉大海,也就失去了這個標記的意義。
IntelliJ IDEA允許我們添加特殊類型的註釋,使得這些註釋在編輯器中突出顯示,它們被索引,並在 TODO 工具窗口 中列出。這樣,我們就容易追蹤自己的 TODO 了。
默認的 TODO
默認情況下,IntelliJ IDEA識別兩種模式:小寫和大寫的 TODO 和 FIXME 這些模式可在任何受支持文件類型的行註釋和塊註釋內部使用。我們可以根據需要修改默認模式或添加自己的模式
如上圖,我們可以創建多行的 TODO (類似 Spring Boot 中的 YAML 配置多個值),需要縮進第一行之後的註釋行。如果沒有縮進,則將行視為常規註釋行
要禁用多行 TODO 項目,使用快捷鍵 ⌘ + , 打開 Preferences, 搜索 TODO (Editor | TODO), 你會看到如下界面
要查看系統中的所有 TODO,請打開 TODO 工具窗口 (快捷鍵 ⌘ + 6 )。切換選項查看 TODO 範圍:
- 從當前項目中的所有文件
- 僅基於當前文件的範圍
- 指定範圍的文件
- 活動的變更列表
到這裡 Intellij IDEA 默認提供的 TODO 就介紹完了,為了能更快的找到我們自己的 TODO,我們就需要進行自定義
自定義 TODO
重新打開 TODO 位置,新增 TODO item,這裡新增 optimize,用於標識待優化內容
添加個過濾器,用於 TODO 的分組
隨便添加一個優化備註,通過以上介紹的功能,快速定位到我們自己的 TODO
如果你的待辦事項通常是相對固定的描述,你也可以配合 Live Template 快速生成 TODO 內容
高清大圖,請查看原文:https://dayarch.top/p/how-to-use-todo-feature.html
總結
當團隊規模很大,你又同時有很多待辦的時候,TODO 特性可以幫助我們做標識,自定義 TODO 可以幫我們快速定位,我們可以充分利用這個特性,但是
定期清理 TODO
靈魂追問
- 你覺得項目中代碼有哪些不規範/不夠整潔的地方?(歡迎到博客下方留言討論)
趣味原創解析Java技術棧問題,將複雜問題簡單化,將抽象問題圖形化落地
如果對我的專題內容感興趣,或搶先看更多內容,歡迎訪問我的博客 https://dayarch.top
閱讀更多 日拱一兵 的文章