JetBrains Rider 2024.1 ヘルプ

Web 固有のファイルテンプレート

ファイルテンプレートは、プロジェクトツリーのコンテキストメニューのファイル | 新規メニューまたは新規セクションを使用して作成する新しいファイルの既定の内容の仕様です。

作成するファイルの種類に応じて、テンプレートは、その種類のすべてのファイルに期待される初期コードとフォーマットを提供します (業界または言語の標準、企業ポリシー、その他の理由に従って)。

JetBrains Rider は、新しいファイルを作成するときに提案される、サポートされているすべてのファイルタイプの定義済みテンプレートを提供します。

JetBrains Rider: Creating a file from template

ファイルテンプレートの管理と構成

  • Ctrl+Alt+S を押して設定を開き、エディター | ファイルテンプレート | 他の言語を選択します。

詳細は、他の言語を参照してください。

デフォルトでは、テンプレートのリストには、JetBrains Rider によって提供される事前定義されたテンプレートのみが含まれています。それらのいくつかは内部的なものです。つまり、削除したり名前を変更したりすることはできません。JetBrains Rider は、内部テンプレートの名前を太字で示しています。変更したテンプレートの名前、および手動で作成したカスタムテンプレートは、青色で表示されます。

次の手順では、ファイルテンプレートを作成する方法について説明します。インクルードテンプレートの作成にも同様の手順を使用できます。

新しいファイルテンプレートを作成する

  1. Ctrl+Alt+S を押して設定を開き、エディター | ファイルテンプレート | 他の言語を選択します。

  2. スキームリストを使用して、ファイルテンプレートが適用されるスコープを選択します。

    • デフォルト : IDE レベルで作成されたファイルテンプレート。これらのテンプレートは、現在の IDE インスタンスで開くすべてのプロジェクトで使用できます。特定のプロジェクトに関係なく、好みの個人用テンプレートとして使用します。JetBrains Rider は、グローバルテンプレートを fileTemplatesIDE 構成ディレクトリに保存します。

    • プロジェクト : 現在のプロジェクトに固有のファイルテンプレート。これらのテンプレートは、このプロジェクトで作業するすべてのユーザーが利用できます。JetBrains Rider は、.idea/fileTemplates のプロジェクトフォルダーに保存します。

  3. ファイルタブで、the Create Template button をクリックし、テンプレート名、ファイル拡張子、結果のファイルの名前、テンプレートの本体を指定します。

  4. 変更を適用し、ダイアログを閉じます。

既存のファイルテンプレートをコピーする

  1. Ctrl+Alt+S を押して設定を開き、エディター | ファイルテンプレート | 他の言語を選択します。

  2. ファイルタブで、the Copy Template button をクリックし、必要に応じてテンプレートの名前、ファイル拡張子、本文を変更します。

  3. 変更を適用し、ダイアログを閉じます。

ファイルをテンプレートとして保存する

  1. エディターでファイルを開きます。

  2. メインメニューで、ファイル | ファイルをテンプレートとして保存に移動します。

  3. 「ファイルをテンプレートとして保存」ダイアログで、新しいテンプレート名と拡張子を指定し、必要に応じて本文を編集します。ファイルテンプレートで使用される構文の詳細については、「構文」を参照してください。

    • ファイル名 : 必要に応じて、このテンプレートから作成されるファイルの名前を指定します。デフォルトでは、JetBrains Rider はファイルを追加するときにユーザーに名前の入力を求めます。特定の名前をハードコードしてプロンプトを完全に回避したり、使用可能な変数からテンプレートを作成したりできます。例: 指定した名前を使用して、ファイル作成時に選択したディレクトリの 1 つ上のディレクトリに置く方法を次に示します: ../${NAME}

    • スタイルに応じて整形 : このファイルタイプに定義されたコードスタイルに従って、このテンプレートに基づいて生成されたコンテンツを再フォーマットします。

    • ライブテンプレートを使用可能にする : ファイルテンプレート内にライブテンプレートを挿入します。Velocity エスケープ構文を使用して、ライブテンプレート変数をファイルテンプレートに含めます(例: #[[ $MY_VARIABLE$ $END$ ]]#)。

  4. 変更を適用し、ダイアログを閉じます。

構文

ファイルテンプレートは Velocity テンプレート言語 (英語)(VTL) を使用します。これには、次の構成が含まれます。

  • プレーンテキストはそのままレンダリングされます。

  • 値に置き換えられる変数。例: ${NAME} は、ファイルを追加するときにユーザーが指定した名前を挿入します。

  • #parse#set#if などを含むさまざまなディレクティブ。

$ または # の入力を開始して、使用可能な変数およびディレクティブの補完候補を参照します。

詳細については、VTL リファレンスガイド(英語)を参照してください。

次の例は、JetBrains Rider で JavaScript クラスを作成するためのデフォルトのテンプレートを示しています。

/** * Created by ${USER} on ${DATE} */

このテンプレートでは、${USER}${DATE} はテンプレート変数です。

新しい JavaScript ファイルを作成すると、このテンプレートは次のような内容のファイルを生成します。

/** * Created by John.Smith on 6/7/11 */

関連ページ:

.NET 固有のテンプレート

このセクションには、C#、VB.NET、ASP.NET、Razor、XAML コードの作成に使用できる .NET 固有のコードテンプレートのドキュメントが含まれています。テンプレートの種類、テンプレートスコープ、テンプレート変数、テンプレートマクロ、テンプレートを適用するライブテンプレートを使用してソースコードを作成する、コードフラグメントをテンプレートで囲む、テンプレートからファイルを作成する、テンプレートを作成および編集するライブ / サラウンドテンプレートを作成する、ファイルテンプレートを...

ライブテンプレート変数

ライブテンプレートの略語を展開すると、その変数は値を入力できる入力フィールドとして表示されるか、値に置き換えられます。これらは、変更可能なデフォルト値または関数を使用して計算された値です。テンプレート内で変数を宣言するには、次の形式を使用します: 式では、ドル文字を開閉せずに変数名を使用します(例:)。式を使用して各変数を定義し、式が評価に失敗した場合のデフォルト値を提供します。この式には、次の構成が含まれる場合があります。二重引用符で囲まれた文字列定数、ライブテンプレートで定義されている他の変数...

Emmet

Emmet ツールキットは、HTML、CSS、JSX によるコーディングを強化します。JetBrains Rider を移動せずに Emmet コードテンプレートを使用できます。テンプレートを正しいマークアップに展開するには、その略語を入力してを押します。を別のキーに置き換えるには、「略語拡張キーを構成する」を参照してください。例: HTML ファイルでと入力し、を押して 3 × 2 テーブルのスタブを取得します。<table> <tr> <td><...