ReSharper 2020.3 ヘルプ

ファイルヘッダースタイル

コピーライト表示やその他の識別メッセージにファイルヘッダーを使用するのが一般的な方法です。ReSharper を使用すると、デフォルトのヘッダーテキストを構成して、ソリューションのコードファイルに自動的に挿入できます。

ReSharper オプションまたは .editorconfig ファイル内のいずれかでファイルヘッダーを構成し、それをファイルテンプレートで作成された新しいファイルに追加し、コードクリーンアップを使用して既存のファイルに挿入できます。

ReSharper オプションでファイルヘッダーを構成する

  1. メインメニューから ReSharper | オプションを選択するか、Alt+R O を押してから、左側のコード編集 | ファイルヘッダーテキストを選択します。

  2. ファイルヘッダーテキスト領域で、コードファイルに挿入したい任意のテキストを挿入します。ファイルヘッダーにさまざまな情報を含めることができるマクロを使用することもできます。マクロを使用するには、マクロを入力するか、対応するマクロをクリックします。現在のキャレット位置に挿入されます。

  3. 必要に応じて、ファイルヘッダーを領域で囲むには、領域の名前を名前の付いた領域へのファイルヘッダーの包含フィールドに入力します。

  4. オプションダイアログで保存をクリックして変更を適用し、ReSharper に保存場所を選択させるか、次へ保存リストを使用して変更を特定の設定レイヤーに保存します。詳細については、ReSharper 設定の管理と共有を参照してください。

EditorConfig を介してファイルヘッダーを構成する

  1. ファイルヘッダーを構成する .editorconfig ファイルを開くか、新しいヘッダーを作成します。

  2. file_header_template プロパティをファイルに追加します(例:

    file_header_template=Your Company. \nSome info about {fileName}

新しく作成されたファイルにファイルヘッダーを追加する

  1. 新しいファイルテンプレートを作成するまたは、ファイルヘッダーを追加する既存のテンプレートを編集します。

  2. テンプレートの先頭にテンプレートパラメーター追加し、それを「ファイルヘッダー」マクロに関連付けます。

    ReSharper: File template with file header
  3. テンプレートを保存します。

  4. このテンプレートで作成された新しいファイルには、指定されたファイルヘッダーがあります。

コードクリーンアップを使用して既存のファイルにファイルヘッダーを挿入する

  1. メインメニューから ReSharper | オプションを選択するか、Alt+R O を押します。

  2. クリーンアッププロファイル設定ページに移動します: コード編集 | コードのクリーンアップ | プロファイル

  3. 新しいカスタムクリーンアッププロファイルを作成するセクションの説明に従って、新しいプロファイルを作成します。新しいプロファイルの選択したプロファイル設定セクションで、ファイルヘッダーを更新するチェックボックスをオンにします。必要に応じて、このプロファイルで他のコードクリーンアップタスクを有効にすることができます。

  4. オプションダイアログで保存をクリックして変更を適用し、ReSharper に保存場所を選択させるか、次へ保存リストを使用して変更を特定の設定レイヤーに保存します。詳細については、ReSharper 設定の管理と共有を参照してください。

  5. ファイルヘッダーを更新する範囲を選択します。

    • キャレットをファイルの任意の場所に設定して、ファイルヘッダーをファイルに更新します。

    • ソリューションエクスプローラーの 1 つまたは複数の項目を選択して、これらのノードおよびその子項目にあるファイルのファイルヘッダーを更新します。

  6. 以下のいずれか 1 つを実行します:

    • Control+Alt+F を押すか、メインメニューから ReSharper | 編集 | コードのクリーンアップ... を選択してください。

    • テキストエディターの任意の場所を右クリックするか、選択項目を右クリックし、コンテキストメニューでコードのクリーンアップを選択します。

  7. 開いているコードのクリーンアップダイアログで、新しく作成したプロファイルを選択します。

  8. 実行をクリックします。ReSharper は、選択したスコープのファイルヘッダーを更新します。

  9. コードのクリーンアップダイアログを開かずにファイルヘッダーを挿入してプロファイルを選択する場合は、作成したプロファイルをサイレントクリーンアップにバインドし、Control+Shift+Alt+F を押して実行できます。ファイルヘッダーの挿入と他のコードスタイルのタスクを組み合わせたカスタムクリーンアッププロファイルを作成することもできます。

この機能は、次の言語とテクノロジーでサポートされています。

関連ページ:

ReSharper 設定の管理と共有

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

EditorConfig を使用する

どのフォーマットスタイルの設定がファイルフォーマット情報ウィンドウの現在のファイルに影響するかを見ることができます。ReSharper は、EditorConfig 形式で定義されたコード形式スタイル、コード構文スタイル、C# の命名スタイル、コードインスペクション重大度レベルをサポートします。Matthell は、ReSharper が EditorConfig を使用してフォーマットルールの設定全体をどのように維持するのをヘルプいるかを示しています。EditorConfig とは何ですか? R...

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

ファイルテンプレートは、型宣言、単体テストなどの定義済みコードで 1 つ以上の新しいファイルを作成するために使用されます。ファイルテンプレートにはショートカットはなく、説明によって識別されます。詳細については、テンプレートからファイルを作成する \ およびマルチファイルテンプレートを作成するを参照してください。新しいファイルテンプレートは、他の開発者がすぐに利用できます。必要に応じて、チーム共有レイヤーを含むさまざまな設定レイヤーに新しいコードテンプレートを作成できます。必要に応じて、後でチーム共...

テンプレートパラメーターの宣言

コードテンプレートは、周囲のコンテキストに合わせて調整したり、適用時にインタラクティブに動作したりすることもできます。これはすべて、テンプレートパラメーターとテンプレートマクロを使用して行われます。テンプレートエディターでテンプレートパラメーターを定義および編集できます。パラメーター(の接頭辞と接尾辞)を入力すると、すぐにテキスト領域変数の編集ダイアログの右側にあるパラメーターセクションで使用できるようになります。マクロを選択をクリックすると、その動作を設定できます。テンプレート内の任意のパラメ...

テンプレートマクロ

コードテンプレートを適用すると、ReSharper はいくつかの値でテンプレートパラメーターを初期化します。これらの値を計算するために、テンプレートマクロを使用します。テンプレートマクロは、周囲のコンテキスト(たとえば、現在のファイル名、現在のソリューション名、名前空間、クリップボードコンテンツなど)に基づいて多くの有用なデータを取得できます。さらに、マクロはコード補完アクションを呼び出し、型、変数、タグなどを推測および提案できます。新しいテンプレートパラメーターを宣言するとすぐに、そのパラメー...

コードのクリーンアップダイアログ

コードのクリーンアップダイアログでは、利用可能なコードクリーンアッププロファイルを使用して、選択したスコープ内のコードをクリーンアップしたり、カスタムクリーンアッププロファイルを作成および編集したりできます。このダイアログでクリーンアッププロファイルを作成または変更する場合、変更はスマート保存ロジックを使用して保存されることに注意してください。変更を共有設定レイヤーに保存する必要がある場合は、ReSharper オプションのページで変更を行い、次へ保存をクリックしてから、目的の設定レイヤーを選択...