前言編輯器
有時,您須要標記部分代碼以供未來參考,好比: 優化,改進,可能的更改,要討論的問題等。一般咱們會在代碼中加入以下的標記表示待辦:ide
//TODO 我將要在這裏作 xxx
你這樣作,別人也會這樣作。一時間,項目中可能會存在大量的 TODO,當你搜尋你的 TODO 時也就變得很是麻煩,如同石沉大海,也就失去了這個標記的意義。工具
IntelliJ IDEA容許咱們添加特殊類型的註釋,使得這些註釋在編輯器中突出顯示,它們被索引,並在 TODO 工具窗口 中列出。這樣,咱們就容易追蹤本身的 TODO 了。優化
默認的 TODO3d
默認狀況下,IntelliJ IDEA識別兩種模式:小寫和大寫的 TODO 和 FIXME 這些模式可在任何受支持文件類型的行註釋和塊註釋內部使用。咱們能夠根據須要修改默認模式或添加本身的模式code
如上圖,咱們能夠建立多行的 TODO (相似 Spring Boot 中的 YAML 配置多個值),須要縮進第一行以後的註釋行。若是沒有縮進,則將行視爲常規註釋行blog
要禁用多行 TODO 項目,使用快捷鍵 ⌘ + , 打開 Preferences, 搜索 TODO (Editor | TODO), 你會看到以下界面索引
要查看系統中的全部 TODO,請打開 TODO 工具窗口 (快捷鍵 ⌘ + 6 )。切換選項查看 TODO 範圍:博客
自定義 TODOhash
從新打開 TODO 位置,新增 TODO item,這裏新增 optimize,用於標識待優化內容
添加個過濾器,用於 TODO 的分組
隨便添加一個優化備註,經過以上介紹的功能,快速定位到咱們本身的 TODO
若是你的待辦事項一般是相對固定的描述,你也能夠配合 Live Template 快速生成 TODO 內容
高清大圖,請查看原文
總結
當團隊規模很大,你又同時有不少待辦的時候,TODO 特性能夠幫助咱們作標識,自定義 TODO 能夠幫咱們快速定位,咱們能夠充分利用這個特性,可是
按期清理 TODO
靈魂追問
你以爲項目中代碼有哪些不規範/不夠整潔的地方?(歡迎到博客下方留言討論)
tan日拱一兵轉發在看也很贊喜歡做者