PyCharm 2024.3 ヘルプ

TODO コメント

時々、将来の参照のためにコードの一部をマークする必要があります: 最適化と改善の領域、起こり得る変更、議論される質問など。PyCharm を使用すると、エディターでハイライトされ、インデックスが付けられ、TODO ツールウィンドウにリストされる特別なタイプのコメントを追加できます。この方法で、あなたのチームメイトは注意が必要な問題を追跡できます。

TODO comments example

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

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

  • 最初のコメント行に続くコメント行のテキストをインデントします。

    複数行の TODO アイテムをインデントするには、スペースとタブ、または両方を組み合わせて使用できます。

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

  1. Ctrl+Alt+S を押して設定を開き、エディター | TODO を選択します。

  2. 次の行のインデント付きテキストを同じ TODO の一部として扱うチェックボックスをクリアします。

TODO comments example

TODO アイテムを表示する

  • TODO ツールウィンドウを開きます: 表示 | ツールウィンドウ | TODO

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

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

The TODO tool window

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

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

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

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

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

    \boptimize\b.*

    これは「optimize」という単語 (\b は単語の境界を指定します) と一致し、コメント内に他の文字をいくつでも含めることができます。

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

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

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

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

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

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

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

関連ページ:

カラースキームの切り替え

このセクションを使用して、PyCharm エディターの配色を選択します。スキームワークスペースで使用する配色を選択してください。このボタンをクリックすると、次のコマンドが呼び出されます(選択したスキームに応じて)。複製: 現在選択されているカラー設定を新しいスキームとして保存します。新しいスキームを保存するにはを押し、操作をキャンセルするにはを押します。デフォルトの復元: 選択したカラースキームを PyCharm に同梱されている初期デフォルトにリセットします。定義済みのカラースキームを選択...

スコープとファイルの色

スコープは、プロジェクト内のファイルとフォルダーのグループです。スコープを使用して、さまざまな IDE ビューでプロジェクト項目を視覚的に区別し、特定の操作の範囲を制限できます。スコープは、プロジェクト内のファイルを論理的に編成するように設計されています。テストソースはテスト関連のスコープに移動でき、製品コードは製品ファイルのスコープに関連付けることができます。これらの論理チャンクにより、プロジェクトの管理が容易になります。例: テスト関連のインスペクションをテストクラスでのみ実行すると、アプリ...

バージョン管理統合サポート

PyCharm は 2 つのレベルでバージョン管理統合をサポートします。IDE レベルでは、VCS 統合は、デフォルトで有効になっているバンドルされたプラグインのセットを通じて提供されます。プロジェクトレベルでは、プロジェクトフォルダーを 1 つまたは複数のバージョン管理システムと関連付けることで、VCS 統合が有効になります。プロジェクトルートをバージョン管理システムに関連付ける:PyCharm を使用すると、プロジェクトとバージョン管理システムの統合を迅速に有効にし、それをプロジェクトルー...

正規表現構文リファレンス

このセクションは、検索と置換の作成、およびナビゲーションパターンの発行に使用できる正規表現構文の概要です。RegEx 構文リファレンス:次の文字を特殊文字またはリテラルとしてマークします。例:n は文字 n と一致します。「\n」は改行文字と一致します。シーケンスはと一致し、はと一致します。入力の始めに一致します。入力の終わりに一致します。直前の文字と 0 回以上一致します。例:

ファイル、フォルダー、テキストソースを比較する

PyCharm を使用すると、ファイル、フォルダー、ローカルファイルとそのリポジトリバージョン、データベースオブジェクト、テキストソース間の違いを確認できます。ファイルを比較:2 つまたは 3 つのファイルを比較するプロジェクトツールウィンドウで、比較するファイルを選択してを選択するか、を押します。または、1 つのファイルを選択し、コンテキストメニューから比較を選択して、プロジェクトの外部にあるファイルを選択します。アクティブなエディターをクリップボードと比較するエディターの任意の場所を右ク...

言語インジェクション

言語インジェクションを使用すると、コードに埋め込まれた他の言語のコード部分を操作できます。文字列リテラルに言語 (HTML、CSS、XML、RegExp など) を挿入すると、プロジェクトのメイン言語でなくても、挿入されたコードに対して包括的なコーディング支援を受けることができます。一時的に言語をインジェクションするデフォルトでは、IDE は一時的に言語を挿入します。これは、埋め込まれた要素を削除すると、インジェクションも失われることを意味します。言語を挿入する文字列リテラル、タグ、属性内にキャ...