PyCharm 2026.1 Help

ライブテンプレートを作成する

次の手順例は、現在の日付とユーザー名で TODO コメントのテンプレートを作成する方法を示しています。

  1. Ctrl+Alt+S を押して設定を開き、 エディター | ライブテンプレート を選択します。

  2. 新しいライブテンプレートを作成するテンプレートグループ(たとえば、 other )を選択します。

    テンプレートグループを選択しない場合、ライブテンプレートが user グループに追加されます。

  3. 追加ボタン をクリックし、 ライブテンプレート​ を選択します。

  4. テンプレートが使用可能なコンテキストを指定します。 デフォルトではコンテキストが指定されておらず、PyCharm はダイアログの下部にメッセージを表示します。

    メッセージにある 定義 をクリックし、該当するコンテキストの横にあるチェックボックスを選択します。

  5. 略語 フィールドで、テンプレートの展開に使用される文字を指定します。 例: todo。 新しく追加したテンプレートを適用する言語も設定できます。

    ToDo テンプレートの追加
  6. (オプション) 説明 フィールドに、将来の参照用にテンプレートを記述します。

    例: Insert TODO comment with the current date and username

  7. テンプレートテキスト フィールドで、 変数を含むテンプレートの本文を指定します。 例:

    # TODO $DATE$ $USER$: $END$
  8. 使用して変数を定義する 変数を編集 をクリックして 機能を:

    名前

    デフォルト値

    定義済みはスキップ

    DATE

    date()

    なし

    はい

    USER

    user()

    なし

    はい

    式の評価に失敗した場合のデフォルト値を設定できますが、これらの特定の関数は常に有効な値を返す必要があります。 変数の 定義済みはスキップ オプションを無効にして、展開された値をハイライトし、必要に応じてユーザーが変更できるようにすることもできます。

    テンプレート変数の編集
  9. すべての変更を適用します。

  10. エディターで todo と入力し、 Tab を押します。

    現在のシステム日付とユーザー名に応じて、テンプレートは次のように展開されます:

    # TODO 09/02/2021 jetbrains:

    テンプレートを使う

コードの断片から新しいテンプレートを作成する

  1. エディターで、テキストフラグメントを選択してライブテンプレートを作成します。

  2. メインメニューから コード | ライブテンプレートとして保存… を選択します。 ライブテンプレートのリストが開きます。 このリストでは、新しく作成されたテンプレートが user グループに追加されています。

  3. テンプレートの省略形、オプションの説明(テンプレートの目的を識別するため)を指定し、テンプレート本体を変更します。 テンプレートに 変数が定義されている場合は、 変数の編集 をクリックして設定します。

  4. 変更を適用するには、 OK をクリックします。

既存のテンプレートをコピーする

同じテンプレートを複数のグループで再利用する場合、または別のテンプレートに基づいて新しいテンプレートを作成する場合は、既存のテンプレートを複製できます。

  1. 設定 ダイアログ(Ctrl+Alt+S )の エディター | ライブテンプレート ページで、コピーするテンプレートを選択します。

  2. ツールバーの 複製 The Duplicate button をクリックします。 新しいテンプレートアイテムがオリジナルと同じグループに追加され、選択されます。

  3. テンプレートの新しい省略形、オプションの説明(テンプレートの目的を識別するため)を指定し、必要に応じてテンプレート本体を変更します。 テンプレートに 変数が定義されている場合は、 変数の編集 をクリックして設定します。

  4. 変更を適用するには、 OK をクリックします。

2026 年 6 月 1 日