JetBrains Rider 2025.3 ヘルプ

テンプレート変数

コードテンプレートの本体には、次のものが含まれます。

  • ソースコードの構造とコメントを表すプレーンテキスト。テンプレートを適用するとそのまま挿入されます。

  • テンプレートを適用すると動的に置き換えられるテンプレート変数。テンプレート変数の形式は次のとおりです。

    $PARAM_NAME$ - ここで、PARAM_NAME は任意の識別子です。

定義済みの変数

次のテンプレート変数は、JetBrains Rider で事前に定義されています。

  • $END$ — テンプレートが適用された後のキャレットの位置。

  • $SELECTION$ — テンプレートを呼び出す前にユーザーが選択したテキスト。この変数は、囲みテンプレートでのみ使用されます。

  • $SELSTART$ — テンプレートの適用に選択されるテキストブロックの開始位置。

  • $SELEND$ — テンプレートの適用に選択されるテキストブロックの終了位置。

ユーザー定義変数

テンプレートを作成または編集するときに、他のすべての変数を任意の識別子で定義できます。通常、テンプレートが適用されるときにそれらの値を計算するためのマクロを変数に提供する必要があります。

また、各変数を編集可能にして、テンプレートの適用時にユーザーが値を変更できるようにすることもできます。

編集可能な変数

コードテンプレートに編集可能な変数がない場合、ユーザーの操作なしで即座に適用されます。編集できない変数がある場合は、マクロを使用してすべて自動的に計算されます(たとえば、固定値、現在のネームスペース、型名、クリップボードの内容を挿入することによって)。

テンプレートコードをソースコードに挿入した後、テンプレート開発者が $END$ または $SELEND$ 変数で指定した位置に入力を再開しますが、挿入されたコードの一部を変更する必要がある場合は、戻って編集してください。

対照的に、編集可能な変数は変更が必要なフィールドを公開します。しばしば、基礎となるマクロによってフィールドの選択肢が提案されます。JetBrains Rider に精通しているため、あらかじめ定義されたテンプレートの多くに編集可能な変数があることがわかります。また、テンプレートを作成および編集するセクションを勉強して、編集可能な変数でカスタムテンプレートを作成および編集する方法を学ぶこともできます。

例: コンテナーのすべての要素に対する反復のためのうまく設計されたテンプレートは、編集可能な変数を使用して次のものを選択できます。

  • ループ索引変数の適切な名前(たとえば、i または j)。

  • 反復されたコンテナーの式として、現在のスコープ内の指定された型(たとえば、配列またはリスト)のすべての変数のリスト。

  • 反復中に現在のコンテナー要素を保持する、割り当てられた変数の適切な名前。

  • 反復されたコンテナー内の要素の型。

編集可能な変数を含むテンプレートが適用されると、JetBrains Rider はホットスポットセッションをエディターにデプロイします。このセッションでは、すべての変数の値を段階的に指定または選択できます。変数を入力に置き換えるか、提案された値の 1 つを受け入れることができます。

編集可能な変数を含むテンプレートを適用する例は、ライブテンプレートを使用したソースコードの作成およびテンプレートで周囲のコードフラグメントのセクションに示されています。

2024 年 2 月 11 日

関連ページ:

Web 固有のテンプレート

このセクションには、HTML、JavaScript、TypeScript などの Web アプリケーションコードの作成に使用できる Web 固有のコードテンプレートのドキュメントが含まれています。Web 固有のライブテンプレートライブテンプレートを作成する、ライブテンプレート変数、ライブテンプレートを共有する、Emmet、Web 固有のファイルテンプレートファイルテンプレート変数、テンプレート内の再利用可能なコンテンツ、ファイルテンプレートを共有する、2024 年 2 月 11 日ソーステンプレ...

コードフラグメントをテンプレートで囲む

サラウンドテンプレートは、式、単一のステートメント、または任意のコードブロックを、またはその他のコード構造ですばやく囲むために使用されます。テンプレートが拡張されると、JetBrains Rider はコードをインテリジェントに再フォーマットし、選択を調整し、最後にキャレットを再配置して、便利な位置から入力を続行できるようにします。JetBrains Rider は、サポートされているすべての言語で多数のサラウンドテンプレートをすぐに使用できますが、特定のケースに合わせてサラウンドテンプレートを...

テンプレート変数を宣言する

コードテンプレートは周囲の状況に合わせて調整したり、適用したときに対話的に動作したりすることもできます。これはすべてテンプレート変数とテンプレートマクロで行われます。特定のテンプレートが選択されている場合は、テンプレート設定ページでテンプレート変数を定義および編集できます。変数(接頭辞と接尾辞が)を入力するとすぐに、変数の編集ダイアログで使用できるようになります。次に、マクロを変更をクリックしてその動作を構成できます。テンプレート内の変数は何度でも使用できます。それらの値は、テンプレートが適用さ...

ライブテンプレートを使用してソースコードを作成する

JetBrains Rider は、サポートされているすべての言語用に事前定義されたライブテンプレートを豊富に提供します。事前定義テンプレートのリストには、コレクションの反復、アサーションメソッドの記述、新しい配列の作成、値の出力、LINQ クエリのコーディング、自動プロパティの生成などのテンプレートが含まれています。ライブテンプレートを使用してコードフラグメントを作成するエディターで、ライブテンプレートからコードフラグメントを挿入する場所にキャレットを置きます。テンプレートのショートカットまた...

テンプレートスコープ

JetBrains Rider は、コードテンプレートを利用できる範囲をいくつか定義します。スコープは、特定のコードテンプレートの使用を関連するコンテキストに限定できます。例: 定義済みのライブテンプレート itar(配列の反復) は、デフォルトで C# 2.0+ ステートメントで使用できます。これは、この特定のスコープがこのテンプレートに対して定義されていることを意味します。itar テンプレートは C# ステートメントの本文に適用できますが、メンバーの外側の C# クラスの本文や、たとえば XML...