使用TODO
在大型項目中工作時,如果經常需要創建任務列表,可以讓您的團隊成員了解需要他們關注的問題。這些問題可以包括應該回答的問題,稍后應該做的某些變化,優化和改進等方面。
IntelliJ IDEA 建議在源代碼中使用特殊的 TODO 注釋。這些注釋可以在所有支持的文件類型中使用,并且應該匹配一定的 TODO 模式。IntelliJ IDEA 帶有一個預定義的模式,但您可以根據需要定義任意多的 TODO 模式。遇到匹配事件時,其將被解釋為 TODO 項目。IntelliJ IDEA 根據配色方案的設置突出了這樣的注釋。
創建TODO項目
⒈在編輯器中打開所需的文件,并將插入符放置在應創建 TODO 項目的位置。
⒉創建注釋。例如,您可以使用 Ctrl+Slash 的鍵盤快捷方式。
⒊在注釋中,鍵入與您的一個 TODO 模式匹配的字符串。默認情況下,任何從TODO(不管情況)開始的字符串都被解釋為 TODO 項,并相應地突出顯示。
⒋在 TODO 工具窗口中查看 TODO 項目列表。
源代碼中的 TODO 項目由特定的模式定義。
無論何時更改模式或添加新模式,IntelliJ IDEA 將掃描整個項目并重建 TODO 項目的索引。結果顯示在 TODO 工具窗口,如下文中查看TODO項目 所述。
默認情況下,IntelliJ IDEA 提供了以下兩種模式:
• \btodo\b.*
• \bfixme\b.*
一般的模式看起來像 todo.*
您可能想要查看某個類型的 TODO 注釋,并隱藏其他的類型。為此,IntelliJ IDEA 建議使用過濾器。這樣,您只能顯示符合特定模式的項目。
⒈打開 "設置" 對話框的 "TODO" 頁。
⒉在模式部分,點擊添加按鈕創建一個新的模式,或者編輯按鈕
更新現有的。打開該添加/編輯模式( Add/Edit Pattern)對話框。
⒊在模式字段中,輸入描述所需模式的正則表達式。
⒋在“圖標”列表中,選擇要在 TODO 工具窗口中標記匹配的 TODO 項的所需圖標。
⒌指定 IntelliJ IDEA 中將用于突出顯示源代碼中匹配注釋的顏色和字體屬性。
⒍選擇區分大小寫的復選框,如果您想要模式能夠區分大小寫。
定義用于顯示特定類型的 TODO 項目的過濾器
⒈打開 "設置" 對話框的 "TODO" 頁。
⒉在 "過濾器" 部分,點擊添加按鈕來創建一個新的過濾器,或者編輯按鈕
更新現有的。
⒊在添加/編輯過濾器對話框中,指定過濾器名稱,然后選擇要包含在過濾器中的模式。
要查看項目中的TODO項目,請按照以下一般步驟操作:
⒈打開 TODO 工具窗口,如顯示工具窗口的過程中所述。
工具窗口在多個選項卡中顯示遇到的 TODO 項目:
• 整個項目(項目選項卡)
• 在編輯器當前處于激活的文件中(當前文件選項卡)
• 在已經定義的范圍中(基于范圍(Scope)的選項卡),這對于大型項目非常有用。
• 在當前的更改列表中,如果啟用了版本控制支持。
⒉單擊所需的選項卡(視圖),并瀏覽遇到的 TODO 項目列表。例如,如果選擇 "基于范圍(Scope)的視圖",則必須從下拉列表中選擇范圍。
⒊通過選擇范圍縮小搜索結果列表,并應用過濾器。