ReSharper 2019.3ヘルプ

ライブ/サラウンドテンプレートを作成する

ライブ/サラウンドテンプレートは、既存のファイルにコードを生成するために使用できます(テンプレート本文に $SELECTION$ パラメーターがある場合)。try...catch ステートメントなど、テンプレートコードでコードフラグメントを囲むために使用できます。
各ライブテンプレートは、ショートカットforeachなどの短い文字列)で識別され、エディターで直接入力してテンプレートを呼び出すことができます。

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

ライブ/サラウンドテンプレートの本体は、そのまま現れるプレーンテキストとパラメータで構成されています。テンプレートを呼び出すときに効率を最大にするためにこれらを組み合わせることが考えられます。

新しいライブ/サラウンドテンプレートを作成するには

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

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

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

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

  5. ショートカットフィールドにテンプレートショートカットを指定します。テンプレートからコードを作成するときにテンプレートをすばやく呼び出すために使用されます。それは補完リストにも現れます。「説明」フィールドに、テンプレートの説明(オプション)を入力します。
  6. テンプレートのデフォルトスコープを変更するには、使用可能ハイパーリンクをクリックします。表示されるダイアログで、チェックボックスを使用して、新しいテンプレートを適用できる場所を定義します。一部のスコープを拡張して、詳細(ファイルマスクや言語バージョンなど)を指定できます。

    ReSharper: Selecting a scope for the template

  7. 必要なコードを入力または貼り付け、パラメータと混合してテンプレートの本体を作成します。
    例:テンプレート本体は次のように見えます。

    Live template body
    ご覧のように、強調表示が異なる3種類の要素があります :

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

    • 定義済みパラメータ - この例では、$END$ パラメータは、テンプレートの適用が完了したときにカーソルをどこに配置するかをReSharperに指示します。

    • ユーザ定義パラメータ - ( $の接頭辞と接尾辞の)パラメータをタイプするとすぐに、テキスト領域変数の編集ダイアログの右側のパラメーターセクションで利用可能になります。テンプレートパラメータの宣言セクションの説明に従って、定義されているすべてのパラメーターを構成できます。
      この例では、呼び出し中にクラス名を確立するために、$className$$ をパラメータにしています。 $idType についても同じことが起こります。Idをどのタイプにしたいのかわからないからです。最後に Id プロパティーがあります。クラス名に似せたいため、対応するパラメータの末尾に 'Id'を付けます。

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

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

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

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

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

  10. テンプレートの書式設定オプションを設定する:

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

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

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

最終更新日: 2019年12月12日

関連ページ:

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

ライブテンプレートはVisual StudioのコードスニペットのReSharperのはるかにインテリジェントなバージョンです。コードスニペットとは異なり、ReSharperのテンプレートはコンテキストからどの変数、フィールド、タイプが使用できるかを予測できます。ほとんどの場合、自分で何か入力する必...

テンプレート・パラメーター

コードテンプレートの本体には、次のものが含まれます。ソースコードの構造とコメントを表すプレーンテキスト。テンプレートを適用するとそのまま挿入されます。テンプレートを適用すると動的に置き換えられるテンプレートパラメータ。テンプレートパラメータの形式は次のとおりです。-は任意の識別子です。フォーマットが...

ReSharper設定の管理と共有

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

テンプレートを共有する

コードテンプレートを共有する簡単な方法は、ファイルにエクスポートしてから、それらのファイルを他の開発者と共有することです。他の開発者は、テンプレートをインポートして使用することができます。チームメンバーとテンプレートを共有するもう1つの方法は、ReSharperがコードテンプレートを格納するために使...

テンプレートのインポートとエクスポート

1つまたは複数のコードテンプレートを別のファイルにエクスポートして、他の開発者に配布または共有することができます。他の開発者が作成して共有するテンプレートをインポートすることができます。正しくインポートするには、ReSharperを使用してテンプレートファイルを作成する必要があります。エクスポートさ...

テンプレートの保存

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