TODO コメント

将来参照のためにコードの一部をマーキングする必要がある場合があります。例えば、最適化や改善の領域、変更の可能性、議論すべき質問などです。 PyCharm では、エディターでハイライトされ、プロジェクト解析時にインデックス化され、やることリストツールウィンドウに一覧表示される特別な種類のコメントを追加できます。この方法で、注意が必要な課題をチームで把握できます。

デフォルトでは、PyCharm によって認識されるパターンは TODO と FIXME の2種類あり、小文字と大文字の両方に対応しています。これらのパターンは行内で使用でき、サポートされている任意のファイルタイプのコメントをブロックできます。デフォルトのパターンを変更するか、必要に応じて独自のパターンを追加できます。

作業している言語の標準のコメントスタイルを使用して TODO を記述します。 Markdown では、コメントをエミュレートできます。

複数行の TODO アイテムを作成する

最初のコメント行に続くコメント行のテキストをインデントします。
複数行の TODO アイテムをインデントする際、スペースやタブ、またはその両方を組み合わせて使用できます。

複数行の TODO アイテムを無効にする

Ctrl+Alt+S を押して設定を開き、エディター | TODO を選択します。
Treat indented text on the following lines as part of the same TODO チェックボックスをクリアします。

TODO アイテムを表示する

やることリストツールウィンドウを開きます: 表示 | ツールウィンドウ | TODO。

タブを使用して、表示する TODO アイテムのソースを以下から切り替えます：現在のプロジェクト内のすべてのファイル、現在のファイル内のもののみ、特定のスコープに基づくファイル、またはアクティブな変更リスト内のファイル（バージョン管理統合が構成されている場合）。

ソースコード内の TODO コメントに移動するには、やることリストツールウィンドウで対応する TODO 項目をクリックします。この動作を無効にするには、ツールバーのシングルクリックで移動ボタンを使用します（この場合、TODO 項目をダブルクリックして関連するコメントに移動する必要があります）。

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

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

設定ダイアログ（Ctrl+Alt+S ）で、エディター | TODO を選択します。
正規表現を使用して、カスタムパターンを指定します。
例: コメントに OPTIMIZE という単語のパターンを追加するには、やることリストダイアログのパターンセクションでをクリックし、次の正規表現を入力します。
\boptimize\b.*
これは「optimize」という単語 (\b は単語の境界を指定します) と一致し、コメント内に他の文字をいくつでも含めることができます。
次に、 OK をクリックして新しいパターンを保存します。
フィルターを追加して TODO パターンをグループ化し、やることリストツールウィンドウで対応する TODO アイテムを個別に表示します。
例: Optimization フィルターを新しいパターンで追加するには、やることリストダイアログのフィルターセクションでをクリックし、その名前として Optimization を指定し、このフィルターに含める新しいパターンを選択します。
次に、 OK をクリックして新しいフィルターを保存します。
OK をクリックして、やることリスト設定ダイアログで変更を適用します。
新しいフィルターを適用するには、やることリストツールウィンドウでをクリックし、 Optimization フィルターを選択します。

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

2026 年 6 月 1 日