小小TODO標識，你用對了嗎？

前言

有時，您須要標記部分代碼以供未來參考，好比: 優化，改進，可能的更改，要討論的問題等。 一般咱們會在代碼中加入以下的標記表示待辦:

//TODO 我將要在這裏作 xxx
複製代碼

你這樣作，別人也會這樣作。一時間，項目中可能會存在大量的 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 內容

高清大圖，請查看原文：小小TODO也有大道理

總結

當團隊規模很大，你又同時有不少待辦的時候，TODO 特性能夠幫助咱們作標識，自定義 TODO 能夠幫咱們快速定位，咱們能夠充分利用這個特性，可是

按期清理 TODO

靈魂追問

1. 你以爲項目中代碼有哪些不規範/不夠整潔的地方？(歡迎到博客下方留言討論)

---

歡迎持續關注公衆號：「日拱一兵」

• 前沿 Java 技術乾貨分享
• 高效工具彙總 | 回覆「工具」
• 面試問題分析與解答
• 技術資料領取 | 回覆「資料」

以讀偵探小說思惟輕鬆趣味學習 Java 技術棧相關知識，本着將複雜問題簡單化，抽象問題具體化和圖形化原則逐步分解技術問題，技術持續更新，請持續關注......

---