構造検索と置換

検索パターンのプレースホルダ

パターンは、通常

• ターゲット言語で許可された識別子のみを含むテキスト部分。テキスト部分では、正確に一致させるべきものを定義します。空白、集計文字、改行は無視されることに注意してください。

• ターゲットコードブロックの変数部分の一致を可能にするプレースホルダー。プレースホルダーの形式は次のとおりです。$placeholder_name$ - placeholder_name は任意の識別子です。

各プレースホルダは一度定義しなければならず、パターン内で数回使用できます。プレースホルダを定義するときは、その種類とオプションの制約を定義する必要があります。プレースホルダには 5 種類あります。

• 引数プレースホルダ — メソッド呼び出しの 1 つ以上の引数。必要に応じて、一致させる必要のある引数の最小数または最大数を指定できます。

• 式プレースホルダ — 演算子とオペランドのシーケンス。オプションで、この式によって返されるタイプを指定できます。

• 識別子プレースホルダ — 任意のシンボル識別子。さらに、シンボル名の照合に使用される正規表現を指定できます。

• ステートメントプレースホルダ — セミコロンまたはステートメントのブロックで終わる 1 行のステートメント。必要に応じて、一致するステートメントの最小数または最大数を指定できます。

• タイププレースホルダ — 値型または参照型。デフォルトでは、この種類のプレースホルダーはどのタイプにも一致しますが、特定のタイプを明示的に指定できます。

パターンの特定の部分に対して正しい種類のプレースホルダを選択することが非常に重要であることに注意してください。パターンが一致するコードブロックと一致しない場合は、間違って選択されたプレースホルダーの種類が問題になることがよくあります。

検索パターンを作成する

コードブロックを検索または置換するか、カスタムコードインスペクションを作成するには、検索パターンを作成する必要があります。既存のコードブロックをパターンのベースとして使用することも、新しいものを最初から作成することもできます。

置換パターンを指定する

検索パターンごとに置換パターンを追加すると、検索パターンに一致するコードブロックをすばやく置き換えることができます。

パターンカタログを管理する

作成したパターンを保存すると、ReSharper はそれをパターンカタログに配置します。カタログを見て既存のパターンを調べるには、ReSharper オプションのコードインスペクション | カスタムパターンページに移動するか、パターンで検索ダイアログでパターンカタログ をクリックします。

パターンカタログでは次のことができます。

• パターンをプレビューするには、リストでパターンを選択します。ページの下部には、その本文とプレースホルダの定義が表示されます。

• パターンを削除するには、リスト内でパターンを選択し、ページツールバーの除去をクリックします。

• 新しいパターンを追加するには、ツールバーのパターンの追加をクリックします。ReSharper は、パターンで検索ダイアログを開き、パターンの詳細を指定できます。

• すべてのパターンは ReSharper のコードインスペクションエンジンで使用されるため、一致したコードブロックが自動的に検出されます。

  デフォルトでは、すべての新しいパターンの重大度レベルセレクターに「表示されません」があります。これは、一致したコードブロックがエディターでハイライトされず、特定のスコープでインスペクションを実行したときに検出されないことを意味します。コードインスペクションの検索パターンに一致するコードを検出する場合は、パターンに適切な重大度レベルを選択します。

• 既存のパターンを編集するには、それをダブルクリックするか、選択して、ウィンドウツールバーの編集をクリックします。

  パターンが編集用に開かれている場合、その検索および部品の置換に関する説明を指定できます。検索の説明は、カタログ内のパターンを表示するため、およびエディターでハイライトされる一致したブロックの説明として使用されます。置換の説明は、ハイライトされたブロックに提案されるクイックフィックスの名前として表示されます。詳細については、カスタムコードインスペクションとクイックフィックスを作成するを参照してください。

  パターンの「抑制キー」を指定できます。これは、コメントを使用して、パターンの使用を検出する ReSharper インスペクションを抑制するために使用できる識別子です。

コードを見つけてパターンで置き換える

コードを検索してパターンに置き換えるには、次の 3 つの方法があります。

• パターンで検索コマンドを呼び出して新しいパターンを作成した直後に、コードを検索または置換できます。この場合、パターンで検索ダイアログの右下隅にある検索 / 置換ボタンをクリックするだけです。

• あなたのパターンカタログからパターンの 1 つを使うことができます。これを行うには、ReSharper オプションのコードインスペクション | カスタムパターンページのツールバーで検索をクリックします。

• パターンに一致するコードブロックはエディターでハイライトできます。パターンに置換ロジックが指定されている場合、コードブロックをクイックフィックスに置き換えることができます。必要なのは、パターンに対して「表示しない」以外の重大度レベルを指定することだけです。ReSharper オプションのコードインスペクション | カスタムパターンページの各パターンの右側にある対応するセレクターを使用します。詳細については、カスタムコードインスペクションとクイックフィックスを作成するを参照してください。

最初の 2 つの方法のいずれかを検索すると、ソリューション内のすべての一致するコードブロックが検索結果ウィンドウに一覧表示されます。結果に探しているものが含まれていない場合は、パターンをすばやく変更して検索プロセスを再度呼び出すことができます。これを行うには、ウィンドウツールバーの検索パターンの変更 をクリックします。

最初の 2 つの方法のいずれかで置換を実行すると、ソリューション内のすべての置換候補がパターンで置き換えるダイアログに表示されます。このダイアログでは、候補者を調査してグループ化できます。コンテキストで候補者を表示する場合は、ツールバーのプレビューの表示 をクリックします。候補のいずれかをダブルクリックして、含まれているファイルをエディターで開くこともできます。

表示された候補が置き換えたいものである場合は、ダイアログの下部にある置換をクリックします。

パターンを共有する

検索と置換のパターンは共有設定レイヤーに保存でき、すべてのチームが利用できるようになります。

ReSharper オプションのコードインスペクション | カスタムパターンページでパターンを作成する場合は、パターンの準備ができたら保存先をクリックし、共有設定レイヤーを選択します。

まだ共有されていない既存のパターンを共有するには、そのパターンを編集用に開き、ハイライトパターンの編集ダイアログで「コピーを保存」をクリックします。次に、「保存先」をクリックして、共有設定レイヤーを選択します。