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

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

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

2. ファイルヘッダーテキスト タブで、ソースファイルの先頭に挿入するテキストを入力します。

   ファイルヘッダーテキストにコメント区切り文字を含める必要はありません。 ヘッダーテンプレートを適用する際、ReSharper は特定の言語に合わせた適切な区切り文字を自動的に挿入します。

3. 日付、時刻、投稿者名などの変数情報を追加するには、対応するマクロを使用します。 使用可能なマクロのリストが右側に表示されます。 マクロを使用するには、ヘッダー本文にマクロを入力するか、右側の部分で対応するマクロをクリックして現在のキャレット位置に挿入します。

   ファイルヘッダー変数 タブでは、ヘッダーテキストで再利用する定数値を指定できます。 例: 名前が companyName 、値が My company の変数を追加し、それをヘッダーテンプレートで $Variable.Named("{companyName}") として使用できます。

4. ファイルヘッダーテンプレートを適用すると、デフォルトで ReSharper はファイル内の最初のコメント（ある場合）を既存のファイルヘッダーとして自動的に検出し、指定されたファイルヘッダーに置き換えます。

   この動作を制限し、特定のコメントのみをファイルヘッダーとして考慮する場合は、 ファイルヘッダー開始検出正規表現 フィールドの正規表現を編集します。 例: Copyright で始まる最初のコメントのみに一致するように、これを Copyright .* に変更できます。

   正規表現と一致した既存のヘッダーを再利用する場合は、ファイルヘッダーテンプレート内の目的の位置に ${OldHeader.Text} マクロを追加します。

5. オプションで、ファイルヘッダーを C# の #region .. #endregion で囲むには、 名前の付いた領域へのファイルヘッダーの包含 フィールドに領域の名前を入力します。

6. オプション ダイアログで 保存 をクリックして変更内容を適用し、ReSharper に保存場所を任せるか、 保存先 セレクターから特定のレイヤーを選択して変更を保存します。 詳細については、 resharper 設定の管理と共有 をご参照ください。

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

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

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

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

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

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

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

   

3. テンプレートを保存します。

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

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

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

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

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

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

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

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

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

6. 次のいずれかを実行します。

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

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

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

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

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

変更を保存するとファイルヘッダーが自動的に更新されます

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

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

3. カスタムコードのクリーンアッププロファイルを選択し、 デフォルトに設定する をクリックします（デフォルトプロファイルは サイレントクリーンアップにも使用されます）。

4. コード編集 | コードのクリーンアップ | 一般 オプションページに移動し、 ファイル保存時にクリーンアップを自動的に実行する を選択します。

   オプションで、ファイルマスクによって特定のファイルへの自動クリーンアップを制限できます。

   ファイルの変更された部分のみ を選択して、変更によって影響を受けるコードにクリーンアップが適用され、ファイル内の残りのコードが変更されないようにすることもできます。

   ファイルの変更された部分のみをクリーンアップすることを選択した場合は、次のオプションを使用してこの動作を微調整できます。

   • 部分的なクリーンアップが不可能な場合は完全なクリーンアップを実行する — このオプションに応じて、ReSharper はファイル全体をクリーンアップするか、ファイルの変更部分のみのクリーンアップができない場合は対象ファイルをスキップします。

   • 共有ファイル保存時のクリーンアップを許可する — このオプションを使用して、共有プロジェクトのファイルなど、ソリューションに複数回含まれるファイルの部分的なクリーンアップを有効または無効にします。

5. ダイアログで 保存 をクリックして変更を適用し、ReSharper に保存場所を任せるか、 保存先 セレクターから特定の設定レイヤーを選択して変更を保存します。 詳細については、 resharper 設定の管理と共有 をご参照ください。

6. 次回編集を終了してファイル（ Ctrl＋S​ ）またはすべてのファイル（ Ctrl＋Shift＋S​ ）を保存すると、ReSharper は選択したプロファイルで対象ファイルをクリーンアップします。 デフォルトのクリーンアッププロファイルが選択されていない場合、ReSharper はプロファイルのいずれかを選択するよう促します。

チーム内でファイルヘッダーのスタイルを共有する

• .editorconfig を介してファイルヘッダーを構成している場合は、対応する .editorconfig ファイルがバージョン管理システムに追加されていることを確認してください。

• ReSharper オプション でファイルヘッダーを設定している場合、構成変更は 「ソリューション チーム共有」設定レイヤーに保存してください。希望の変更後、オプション ダイアログ内の ソリューション「solutionName」チーム共有 を 保存先 セレクターで選択します。

  <SolutionName>.sln.DotSettings ファイルがバージョン管理システムに追加されていることを確認してください。