IntelliJ IDEA如何使用TODO

使用TODO

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

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

創(chuàng)建TODO項(xiàng)目

⒈在編輯器中打開(kāi)所需的文件，并將插入符放置在應(yīng)創(chuàng)建 TODO 項(xiàng)目的位置。

⒉創(chuàng)建注釋。例如，您可以使用 Ctrl+Slash 的鍵盤(pán)快捷方式。

⒊在注釋中，鍵入與您的一個(gè) TODO 模式匹配的字符串。默認(rèn)情況下，任何從TODO(不管情況)開(kāi)始的字符串都被解釋為 TODO 項(xiàng)，并相應(yīng)地突出顯示。

⒋在 TODO 工具窗口中查看 TODO 項(xiàng)目列表。

定義TODO模式和過(guò)濾器

源代碼中的 TODO 項(xiàng)目由特定的模式定義。

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

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

• \btodo\b.*

• \bfixme\b.*

一般的模式看起來(lái)像 todo.*

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

定義 TODO 模式

⒈打開(kāi) "設(shè)置" 對(duì)話框的 "TODO" 頁(yè)。

⒉在模式部分，點(diǎn)擊添加按鈕創(chuàng)建一個(gè)新的模式，或者編輯按鈕更新現(xiàn)有的。打開(kāi)該添加/編輯模式( Add/Edit Pattern)對(duì)話框。

⒊在模式字段中，輸入描述所需模式的正則表達(dá)式。

⒋在“圖標(biāo)”列表中，選擇要在 TODO 工具窗口中標(biāo)記匹配的 TODO 項(xiàng)的所需圖標(biāo)。

⒌指定 IntelliJ IDEA 中將用于突出顯示源代碼中匹配注釋的顏色和字體屬性。

⒍選擇區(qū)分大小寫(xiě)的復(fù)選框，如果您想要模式能夠區(qū)分大小寫(xiě)。

定義用于顯示特定類型的 TODO 項(xiàng)目的過(guò)濾器

⒈打開(kāi) "設(shè)置" 對(duì)話框的 "TODO" 頁(yè)。

⒉在 "過(guò)濾器" 部分，點(diǎn)擊添加按鈕來(lái)創(chuàng)建一個(gè)新的過(guò)濾器，或者編輯按鈕更新現(xiàn)有的。

⒊在添加/編輯過(guò)濾器對(duì)話框中，指定過(guò)濾器名稱，然后選擇要包含在過(guò)濾器中的模式。

查看TODO項(xiàng)目

要查看項(xiàng)目中的TODO項(xiàng)目，請(qǐng)按照以下一般步驟操作：

⒈打開(kāi) TODO 工具窗口，如顯示工具窗口的過(guò)程中所述。

工具窗口在多個(gè)選項(xiàng)卡中顯示遇到的 TODO 項(xiàng)目：

• 整個(gè)項(xiàng)目(項(xiàng)目選項(xiàng)卡)

• 在編輯器當(dāng)前處于激活的文件中(當(dāng)前文件選項(xiàng)卡)

• 在已經(jīng)定義的范圍中(基于范圍(Scope)的選項(xiàng)卡)，這對(duì)于大型項(xiàng)目非常有用。

• 在當(dāng)前的更改列表中，如果啟用了版本控制支持。

⒉單擊所需的選項(xiàng)卡(視圖)，并瀏覽遇到的 TODO 項(xiàng)目列表。例如，如果選擇 "基于范圍(Scope)的視圖"，則必須從下拉列表中選擇范圍。

⒊通過(guò)選擇范圍縮小搜索結(jié)果列表，并應(yīng)用過(guò)濾器。