IntelliJ IDEA 2019.2ヘルプ

TODO コメント

場合によっては、将来の参照用にコードの一部にマークを付ける必要があります。最適化と改善の分野、変更の可能性、検討すべき質問などです。IntelliJ IDEAを使用すると、エディターで強調表示され、索引が付けられ、TODOツールウィンドウにリストされている特別なタイプのコメントを追加できます。このようにあなたのチームメイトは注意を必要とする課題を追跡することができます。

Example of TODO comments

デフォルトでは、IntelliJ IDEAによって認識される2つのパターンがあります。TODOFIXME です。これらのパターンは、サポートされているファイルタイプの行コメントとブロックコメントの内側で使用できます。必要に応じて、デフォルトのパターンを変更したり、独自のパターンを追加したりできます。

複数行のTODOアイテムを作成するには、最初の行に続くコメント行をインデントします。インデントがないと、行は通常のコメント行として扱われます。複数行のTODOアイテムを無効にするには、設定/環境設定ダイアログ(Ctrl+Alt+S)でエディター | TODOに移動し、次の行のインデントされたテキストを同じTODOの一部として扱う チェックボックスをオフにします。

TODO項目を表示するには、TODOツールウィンドウ(表示 | ツール・ウィンドウ | TODOまたは Alt+6)を開きます。

ソースコード内のTODOコメントにジャンプするには、TODOツールウィンドウで対応するTODO項目をクリックします。この動作を無効にするには、TODOツールウィンドウのタイトルバーを右クリックし、表示オプションをポイントし、ソースに自動スクロールオプションをクリアします(この場合、TODO項目をダブルクリックして関連するコメントにジャンプする必要があります)。

カスタムパターンを追加してTODOアイテムをフィルタリングする

独自のパターンを追加してリストをフィルタリングし、特定のパターンに一致するTODOアイテムのみを表示できます。例: OPTIMIZE パターンでコード内の可能な最適化の場所をマークし、TODOツールウィンドウで表示するときに他のすべてのTODOアイテムを無視することを選択できます。

  1. 設定/環境設定ダイアログ(Ctrl+Alt+S)で、エディター | TODOを選択します。

  2. 正規表現を使用して、カスタムパターンを指定します。

    例: OPTIMIZE アイテムのパターンを追加するには、TODOダイアログのパターンセクションで The Add button をクリックし、次の正規表現を入力します。

    \boptimize\b.*

    次に、OKをクリックして新しいパターンを保存します。

  3. フィルターを追加してTODOパターンをグループ化し、TODOツールウィンドウで対応するTODOアイテムを個別に表示します。

    例: Optimization フィルターを新しいパターンで追加するには、TODOダイアログのフィルターセクションで The Add button をクリックし、その名前として Optimization を指定し、このフィルターに含める新しいパターンを選択します。

    次に、OKをクリックして新しいフィルターを保存します。

    The TODO settings dialog
  4. OKをクリックして、TODO設定ダイアログで変更を適用します。

  5. 新しいフィルターを適用するには、TODOツールウィンドウで the Filter TODO Items button をクリックし、最適化フィルターを選択します。

パターン用に選択したアイコンは、さまざまなTODOアイテムを区別しやすくするために、TODOツールウィンドウに表示されます。パターンの大/小文字の区別チェックボックスを有効にすることにより、指定された大文字と小文字のみをパターンに一致させることができます。

最終更新日: 2019年10月17日