ReSharper 2024.3 ヘルプ

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

ライブ / 囲みテンプレートは、既存のファイルにコードを生成したり、(テンプレート本体に $SELECTION$ パラメーターがある場合) try...catch ステートメントなどのテンプレートコードでコードフラグメントを囲むために使用できます。

各ライブテンプレートは、ショートカットforeach などの短い文字列)によって識別されます。この文字列をエディターに直接入力して、テンプレートを呼び出すことができます。

ライブ / 囲みテンプレートは、単体テスト用のクラス、DTO、スケルトンの作成など、さまざまな用途に使用できます。

ライブ / 囲みテンプレートの本体は、そのまま表示されるプレーンテキストとパラメーターで構成されています。アイデアは、これらを組み合わせてテンプレートを呼び出すときの効率を最大化することです。

新しいライブ / 囲みテンプレートを作成する

  1. メインメニューから ReSharper | ツール | テンプレートエクスプローラー ... を選択します。

  2. 表示されるテンプレートエクスプローラーウィンドウで、ライブテンプレートまたは囲みテンプレートタブをクリックします。

  3. オプションで、特定の設定レイヤーにテンプレートを作成する場合は、リストで目的のレイヤーを選択します。詳細については、「テンプレートの保管」を参照してください。

  4. 新規テンプレート ThemedIcon.AddLiveTemplate.Screen.(Gray).png をクリックします。新しく作成されたテンプレートがテンプレートエディターで開かれます。

  5. ショートカットフィールドでテンプレートのショートカットを指定します。テンプレートからコードを作成するときにテンプレートをすばやく呼び出すために使用されます。補完リストにも表示されます。説明フィールドに、テンプレートのオプションの説明を入力します。

  6. テンプレートのデフォルトのスコープを変更するには、使用可能ハイパーリンクをクリックします。表示されるダイアログで、チェックボックスを使用して、新しいテンプレートを適用できる場所を定義します。一部のスコープを拡張して詳細 (ファイルマスクや言語バージョンなど) を指定できます。

    テンプレートが非システムアセンブリのクラスとメソッドを使用する場合、これらのアセンブリを参照するプロジェクトでのみテンプレートを使用できるようにすることができます。グローバルカテゴリで、リファレンスを選択し、.dll 拡張子なしでアセンブリ名を指定します。

    ReSharper: Selecting a scope for the template
  7. 目的のコードを入力または貼り付け、パラメーターと混合して、テンプレートの本体を作成します。

    例: テンプレート本体は次のようになります。

    public class $className$ { public $idType$ $className$Id {get; set;} $END$ }

    ご覧のとおり、ハイライトが異なる 3 種類の要素があります。

    • text — テンプレート本文にプレーンテキストとして記述されたものはすべて、テンプレートを呼び出すとそのまま表示されます。

    • 事前定義されたパラメーター — この例では、$END$ パラメーターは、テンプレートの適用が完了した後にキャレットを配置する場所を ReSharper に伝えます。

    • ユーザ定義パラメーター — パラメーター (接頭辞と接尾辞が $) を入力するとすぐに、テキスト領域の右側にあるパラメーターセクションで使用できるようになります。テンプレートパラメーターを宣言するセクションに従って、定義されているすべてのパラメーターを設定できます。

      この場合、呼び出し中にクラス名を確立するために、$className$$ をパラメーターにします。Id をどの型にするかわからないため、$idType でも同じことが起こります。最後に、Id プロパティがあります。クラス名に似せたいため、「Id」という接尾辞が付いた対応するパラメーターを使用するだけです。

    $className$$ パラメーターの異なるハイライト(赤と黒のフレーム)は、テンプレートが呼び出されたときにホットスポットセッションにあるときに赤い入力が初期入力位置として使用されることを意味します。

  8. で使用セレクタを使用して、テンプレートを新しいコードの生成、既存のコードの囲み、その両方に使用できるかどうかを指定します。作成したテンプレートを周囲のコードに使用する場合は、テンプレートを呼び出す前にユーザーが選択したテキストを表す $SELECTION$ パラメーターを追加します。

  9. ニモニックフィールドでは、コードをテンプレートで囲むときに使用する [0-9] 数字を指定できます。

    • いくつかのニーモニック数字が指定されている場合、そのテンプレートは Alt+Enter を押して選択すると囲む ... で使用可能になります。

    • Alt+Control+J を押すと (またはメニューから ReSharper | 編集 | テンプレートで囲む…を選択すると)、指定したニーモニック数字がテンプレートの横に表示されます。対応するキーを押すと、このテンプレートをすぐに適用できます。

  10. テンプレートのフォーマットオプションを設定する:

    • 再フォーマットチェックボックスを選択して、ReSharper がフォーマット設定に従って展開されたコードフラグメントを自動的に再フォーマットするようにします。

    • 修飾された参照を短くするチェックボックスを選択すると、ReSharper が名前空間インポートディレクティブを自動的に挿入するか、テンプレートの適用後に冗長になる修飾子を削除します。このチェックボックスが選択されていない場合、ReSharper はネームスペースインポートディレクティブを挿入しません。

  11. テンプレートを保存するには、Visual Studio メニューでファイル | 選択した項目を保存を選択するか、Ctrl+S を押します。

関連ページ:

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

ライブテンプレートは、Visual Studio のコードスニペットの ReSharper のはるかにインテリジェントなバージョンです。コードスニペットとは異なり、ReSharper のテンプレートは、使用できる変数、フィールド、型をコンテキストから予測できます。ほとんどの場合、自分で何も入力する必要はありません。推奨値のリストから選択するだけです。ReSharper は、サポートされているすべての言語用に事前定義されたライブテンプレートを豊富に提供します。事前定義テンプレートのリストには、コレ...

ReSharper 設定の管理と共有

ReSharper は、階層化された設定のメカニズムを使用して環境設定を保存するため、次の利点があります。さまざまなソリューションで異なる設定を行うことができます。環境設定のさまざまなサブセットを別の場所に保存し、特定のソリューションで作業するときに環境設定を組み合わせることができます。例: 記号のアイコンとチーム設定のコード形式を個人設定で保存し、これらの設定を自動的に組み合わせることができます。設定の特定のサブセットを VCS に保持することにより、チーム内の設定を同期できます。ReShar...

テンプレートを共有する

コードテンプレートを共有する簡単な方法は、ファイルにエクスポートしてから、それらのファイルを他の開発者と共有することです。他の開発者は、テンプレートをインポートして使用することができます。チームメンバーとテンプレートを共有するもう 1 つの方法は、ReSharper がコードテンプレートを格納するために使用する設定レイヤーのメカニズムを使用することです。同じ共有ソリューションに取り組む他の開発者がテンプレートを利用できるようにするには、チーム共有設定レイヤーで新しいコードテンプレートを作成するか...

テンプレートの保管

ReSharper のコードテンプレートに関する興味深い点の 1 つは、分散ストレージです。コードテンプレートは、社内組織の詳細を十分に理解していなくても、使用して管理するのに優秀に動作します。ただし、テンプレートの編集や共有に問題が発生したり、複雑な使用シナリオが発生した場合は、これらの詳細を調べる必要があります。定義済みのテンプレート:すべての事前定義テンプレートは ReSharper インストールに保管されています。事前定義されたテンプレートの削除を含むすべての必要な変更は設定レイヤーに...

テンプレートエクスプローラーウィンドウ

テンプレートエクスプローラーウィンドウには、すべてのコードテンプレートが一覧表示され、作成、編集およびコードテンプレートの管理に必要なコントロールが提供されます。このウィンドウには、3 種類の ReSharper テンプレートを管理するための 3 つのタブがあります。ライブテンプレート:このタブはライブテンプレートを管理するために使用されます。さまざまな言語で利用可能なテンプレートを参照できます。左側にはテンプレートスコープとユーザーカテゴリがあり、右側には選択したスコープとカテゴリでフィルター...

テンプレートエディター

テンプレートエディターは、コードテンプレートの作成と編集に役立ちます。テンプレートエディターが新しいドキュメントタブで開き、テンプレートとアプリケーションコードを切り替えて、作成したテンプレートをすばやくテストできます。テンプレートエディターは、キーワード、コメントなどの基本的なコードのハイライトを提供します。すべてのハイライト色は構成可能です。テンプレートエディターの強調色を構成するメニューからを選択して、ページに移動します。アイテムを表示するリストで、ReSharper テンプレートエディター...