IntelliJ IDEA如何使用TODO

2018-09-30 14:14 更新

使用TODO

在大型項目中工作時,如果經(jīng)常需要創(chuàng)建任務(wù)列表,可以讓您的團隊成員了解需要他們關(guān)注的問題。這些問題可以包括應(yīng)該回答的問題,稍后應(yīng)該做的某些變化,優(yōu)化和改進等方面。

IntelliJ IDEA 建議在源代碼中使用特殊的 TODO 注釋。這些注釋可以在所有支持的文件類型中使用,并且應(yīng)該匹配一定的 TODO 模式。IntelliJ IDEA 帶有一個預(yù)定義的模式,但您可以根據(jù)需要定義任意多的 TODO 模式。遇到匹配事件時,其將被解釋為 TODO 項目。IntelliJ IDEA 根據(jù)配色方案的設(shè)置突出了這樣的注釋。

創(chuàng)建TODO項目

  1. 在編輯器中打開所需的文件,并將插入符放置在應(yīng)創(chuàng)建 TODO 項目的位置。
  2. 創(chuàng)建注釋。例如,您可以使用 Ctrl+Slash 的鍵盤快捷方式。
  3. 在注釋中,鍵入與您的一個 TODO 模式匹配的字符串。默認(rèn)情況下,任何從TODO(不管情況)開始的字符串都被解釋為 TODO 項,并相應(yīng)地突出顯示。
  4. 在 TODO 工具窗口中查看 TODO 項目列表。

定義TODO模式和過濾器

源代碼中的 TODO 項目由特定的模式定義。

無論何時更改模式或添加新模式,IntelliJ IDEA 將掃描整個項目并重建 TODO 項目的索引。結(jié)果顯示在 TODO 工具窗口,如下文中查看TODO項目 所述。

默認(rèn)情況下,IntelliJ IDEA 提供了以下兩種模式:

  • \btodo\b.*
  • \bfixme\b.*

一般的模式看起來像 todo.*

您可能想要查看某個類型的 TODO 注釋,并隱藏其他的類型。為此,IntelliJ IDEA 建議使用過濾器。這樣,您只能顯示符合特定模式的項目。

定義 TODO 模式

  1. 打開 "設(shè)置" 對話框的 "TODO" 頁。
  2. 在模式部分,點擊添加按鈕創(chuàng)建一個新的模式,或者編輯按鈕更新現(xiàn)有的。打開該添加/編輯模式( Add/Edit Pattern)對話框。
  3. 在模式字段中,輸入描述所需模式的正則表達式。
  4. 在“圖標(biāo)”列表中,選擇要在 TODO 工具窗口中標(biāo)記匹配的 TODO 項的所需圖標(biāo)。
  5. 指定 IntelliJ IDEA 中將用于突出顯示源代碼中匹配注釋的顏色和字體屬性。
  6. 選擇區(qū)分大小寫的復(fù)選框,如果您想要模式能夠區(qū)分大小寫。

定義用于顯示特定類型的 TODO 項目的過濾器

  1. 打開 "設(shè)置" 對話框的 "TODO" 頁。
  2. 在 "過濾器" 部分,點擊添加按鈕來創(chuàng)建一個新的過濾器,或者編輯按鈕更新現(xiàn)有的。
  3. 在添加/編輯過濾器對話框中,指定過濾器名稱,然后選擇要包含在過濾器中的模式。

查看TODO項目

要查看項目中的TODO項目,請按照以下一般步驟操作:

  1. 打開 TODO 工具窗口,如顯示工具窗口的過程中所述。

    工具窗口在多個選項卡中顯示遇到的 TODO 項目:

    • 整個項目(項目選項卡)
    • 在編輯器當(dāng)前處于激活的文件中(當(dāng)前文件選項卡)
    • 在已經(jīng)定義的范圍中(基于范圍(Scope)的選項卡),這對于大型項目非常有用。
    • 在當(dāng)前的更改列表中,如果啟用了版本控制支持。
  2. 單擊所需的選項卡(視圖),并瀏覽遇到的 TODO 項目列表。例如,如果選擇 "基于范圍(Scope)的視圖",則必須從下拉列表中選擇范圍。
    IntelliJ IDEA查看項目中的TODO項目
  3. 通過選擇范圍縮小搜索結(jié)果列表,并應(yīng)用過濾器。
以上內(nèi)容是否對您有幫助:
在線筆記
App下載
App下載

掃描二維碼

下載編程獅App

公眾號
微信公眾號

編程獅公眾號