IntelliJ IDEA 2019.1ヘルプ

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. カスタムパターンを指定するには、正規表現 \b<pattern string>\b.*を使用します。 OPTIMIZE 項目のパターンを追加するには、TODOダイアログのパターンセクションにある追加アイコン(Add)をクリックして、次の正規表現を入力します。

    \boptimize\b.*

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

  3. 新しいパターンのフィルターを追加するには、TODOダイアログのフィルターセクションで追加アイコン(Add)をクリックし、新しいフィルターの名前(たとえば Optimization)を指定して、このフィルターに含める新しいパターンを選択します。

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

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

  5. 新しいフィルタを適用するには、TODOツールウィンドウでTODO アイテムをフィルターアイコン(Filter TODO Items)をクリックし、最適化フィルタを選択します。

最終更新日: 2019年6月20日