小小TODO標識,你用對了嗎?


前言

有時,您需要標記部分代碼以供將來參考,比如: 優化,改進,可能的更改,要討論的問題等。 通常我們會在代碼中加入如下的標記表示待辦:

//TODO 我將要在這里做 xxx

你這樣做,別人也會這樣做。一時間,項目中可能會存在大量的 TODO,當你搜尋你的 TODO 時也就變得非常麻煩,如同石沉大海,也就失去了這個標記的意義。

IntelliJ IDEA允許我們添加特殊類型的注釋,使得這些注釋在編輯器中突出顯示,它們被索引,並在 TODO 工具窗口 中列出。這樣,我們就容易追蹤自己的 TODO 了。

默認的 TODO

默認情況下,IntelliJ IDEA識別兩種模式:小寫和大寫的 TODOFIXME 這些模式可在任何受支持文件類型的行注釋和塊注釋內部使用。我們可以根據需要修改默認模式或添加自己的模式

如上圖,我們可以創建多行的 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 技術棧相關知識,本着將復雜問題簡單化,抽象問題具體化和圖形化原則逐步分解技術問題,技術持續更新,請持續關注......



免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM