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

JetBrains Rider 設定でファイルヘッダーを構成する

1. Ctrl+Alt+S を押すか、メニューからファイル | 設定（Windows および Linux）または JetBrains Rider | 環境設定 (macOS) を選択し、左側のエディター | ファイルヘッダーテンプレートを選択します。

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

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

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

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

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

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

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

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

6. 設定ダイアログで保存をクリックして変更を適用し、JetBrains Rider が変更を保存する場所を選択できるようにするか、保存セレクターからこのレイヤーを選択して特定の設定レイヤーに変更を保存します。詳細については、「レイヤーベースの設定」を参照してください。

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

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

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

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

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

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

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

   

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

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

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

1. Ctrl+Alt+S を押すか、メニューからファイル | 設定（Windows および Linux）または JetBrains Rider | 環境設定 (macOS) を選択します。

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

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

4. 設定ダイアログで保存をクリックして変更を適用し、JetBrains Rider が変更を保存する場所を選択できるようにするか、保存セレクターからこのレイヤーを選択して特定の設定レイヤーに変更を保存します。詳細については、「レイヤーベースの設定」を参照してください。

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

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

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

6. Ctrl+R, C を押すか、メインメニューからコード | 再フォーマットとクリーンアップ…を選択します。

7. 開いたコードの再フォーマットとクリーンアップダイアログで、新しく作成したプロファイルを選択し、必要に応じて別のスコープを選択します。

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

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

Git にコミットする前にコードをクリーンアップする

1. Ctrl+K を押すか、メインメニューから Git | コミットを選択します。

2. コミットツールウィンドウで をクリックし、コミットチェック領域でクリーンアップ ... チェックボックスを選択します。

3. プロファイルの選択をクリックして、カスタムコードクリーンアッププロファイルを選択します。

4. コミットまたはコミットとプッシュをクリックします。JetBrains Rider は、コミット用にステージングされたファイルでコードのクリーンアップを実行し、変更をコミットします。

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

1. Ctrl+Alt+S を押して設定を開き、ツール | 保存時のアクションを選択します。

2. コードの再フォーマットとクリーンアップを選択し、カスタムコードクリーンアッププロファイルを選択して、それをファイル全体に適用するか、変更された行のみに適用するかを選択します。

3. 次に編集を終了してファイルまたはすべてのファイルを保存すると、JetBrains Rider は選択されたプロファイルを使用して影響を受けるファイルをクリーンアップします。

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

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

• JetBrains Rider 設定経由でファイルヘッダーを構成している場合は、構成の変更を「ソリューションチーム共有」設定レイヤーに保存します。必要な変更を行った後、設定ダイアログの保存セレクターでソリューション「solutionName」チーム共有を選択します。

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