コードの構文スタイル: 修飾子
型および型メンバーの C# 修飾子は、任意の順序で記述できます。 ただし、コード全体で同様の方法で配置することは、コードの可読性を向上させるための良い方法です。 また、 private と internal の修飾子を明示的に使用したり使用したりしたくない場合もあります。
JetBrains Rider は、既存のコード内で修飾子を整理したり、 コード補完や コード生成機能で新しいコードを生成する際に環境設定を考慮したり、 コードテンプレートを適用したり、 リファクタリングを実行したりするのに役立ちます。
既存のコードに修飾子を配置する
デフォルトでは、JetBrains Rider は private と internal 修飾子を明示的に使用し、修飾子を特定の順序で並べることを提案します。 必要に応じて、これらの設定を 柔軟に設定できます。
コードがこれらの環境設定に準拠していない場合、JetBrains Rider はそのような宣言を ハイライトし、対応する クイックフィックスまたは修飾子の順序に関する スコープ内修正を提案します：
... private 修飾子の場合:
... と internal 修飾子の場合:
修飾子に関するすべての環境設定を一括で適用するための別のオプションは、 コードのクリーンアップです。 組み込みプロファイル フルクリーンアップまたは 再フォーマットして構文スタイルを適用のいずれかを使用して コードクリーンアップを実行するか、後述するように、特定のタスクのみを対象とした カスタムプロファイルを作成して実行することができます。
コードのクリーンアップで修飾子の設定を適用する
Ctrl+Alt+S を押すか、メニューから (Windows および Linux) または (macOS) を選択します。
クリーンアッププロファイル設定ページに移動します: 。
新しいカスタムクリーンアッププロファイルを作成する セクションの説明に従って、新しいプロファイルを作成します。 右側のプロファイル設定で、 ノードを展開し、 タイプに明示的 / 暗黙的修飾子を使用する、 型メンバーに明示的 / 暗黙的修飾子を使用する、 修飾子の並べ替え のチェックボックスをオンにします。
設定 ダイアログで 保存 をクリックして変更を適用し、JetBrains Rider が保存先を選択できるようにするか、 保存 セレクターからレイヤーを選んで特定の設定レイヤーに変更を保存します。 詳細については、「レイヤーベースの設定 」を参照してください。
設定を適用する範囲を選択します。
ファイル内の任意の場所にキャレットを配置して、ファイルに設定を適用します。
ソリューションエクスプローラー 内の 1 つまたは複数の項目を選択して、これらのノードおよびその子項目にあるファイルに設定を適用します。
Ctrl+R, C を押すか、メインメニューから を選択してください。
表示された 整形とクリーンアップ ダイアログで、新しく作成したプロファイルを選択し、必要なら別のスコープを選択してください。 。
OK をクリックします。 JetBrains Rider は選択したスコープ内で環境設定を適用します。
整形とクリーンアップ ダイアログを開いてプロファイルを選択せずに修飾子を整理したい場合は、作成したプロファイルを サイレントクリーンアップにバインドし、 Ctrl+R, G を押して実行できます。 修飾子スタイルの適用と他のコードスタイルタスクを組み合わせた カスタムクリーンアッププロファイルを作成することもできます。
選択したコードブロックに他のすべての フォーマットおよび 構文スタイルルールとともに修飾子の環境設定を適用するには、 Alt+Enter を実行し、 を選択します。
最近変更して Git にコミットする予定のコードに修飾子を配置できます。 JetBrains Rider は、コミットする前に選択した クリーンアッププロファイルを実行します。
Git にコミットする前にコードをクリーンアップする
Ctrl+K を押すか、メインメニューから を選択します。
コミット ツールウィンドウで
をクリックし、 コミットチェック 領域で クリーンアップ ... チェックボックスを選択します。プロファイルを選択 をクリックして、カスタムコードクリーンアッププロファイルを選択します。
コミット または コミットとプッシュ をクリックします。 JetBrains Rider はコミット用にステージングされたファイルでコードのクリーンアップを実行し、その後変更をコミットします。
変更をファイルに保存するたびに修飾子を配置して、編集が常にコードスタイルに準拠するようにすることができます。 ただし、これは Ctrl+S または Ctrl+S を使用して明示的に変更を保存した場合にのみ適用され、 auto-saving ではトリガーされません。 なお、自動保存されたファイルはすべて「再フォーマットとクリーンアップ」キューに配置され、次回の明示的な保存時に処理されます。
変更を保存するときに修飾子を自動的に配置する
Ctrl+Alt+S を押して設定を開き、 を選択します。
整形とクリーンアップ を選択し、カスタムコードクリーンアッププロファイルを選択して、それをファイル全体に適用するか、変更された行のみに適用するかを選択します。
次回、編集を終えてファイルまたはすべてのファイルを保存すると、JetBrains Rider は選択したプロファイルを使って対象ファイルをクリーンアップします。
修飾子の設定を構成する
修飾子に関する環境設定は、 レイヤーベース設定の仕組みで保存されます。 このメカニズムにより、さまざまなソリューションに対して異なる設定を維持したり、これらの設定をバージョン管理システム (VCS) で管理したり、チームメンバーと自動的に共有したりすることが可能になります。
修飾子の設定を構成する
JetBrains Rider 設定 Ctrl+Alt+S の ページに移動し、 構文スタイル タブを選択します。
修飾子 カテゴリでは、修飾子の順序を指定し、
private修飾子とinternal修飾子を明示的に使用するための設定を行います。右列のセレクターを使うと、環境設定と異なるコードを検出する コードインスペクションの 重要度レベルを設定できます。
設定 ダイアログで 保存 をクリックして変更を適用し、JetBrains Rider が保存先を選択できるようにするか、 保存 セレクターからレイヤーを選んで特定の設定レイヤーに変更を保存します。 詳細については、「レイヤーベースの設定 」を参照してください。
また、該当する問題がハイライトされたエディター内で、 private および internal 修飾子の明示的・暗黙的な利用に関する環境設定も変更できます：
エディターで修飾子の設定を変更する
JetBrains Rider のインスペクションでハイライトされているコードの問題にキャレットを置きます。
Alt+Enter を押すか、キャレットの左にある アクションインジケーターをクリックして、 アクションリストを開きます。
アクションリストで、 インスペクション " 型に明示的または暗黙的な修飾子定義を使用する " | 暗黙の「内部」修飾子を優先する：
を選択します。
変更は、 スマートセーブロジックを使用して保存されます。
変更したスタイル環境設定を 共有設定レイヤーに保存したい場合は、 コードスタイルを設定する メニュー項目をクリックするか、選択されているときに Enter を押します。 JetBrains Rider は 設定 の ページを開き、必要に応じて環境設定を変更できます。 保存先 をクリックし、希望する設定レイヤーを選択してください。
同様に、
private修飾子の明示的・暗黙的な環境設定も変更できます。
EditorConfig を介して構文スタイルの設定を行うことができます。 これらの設定は、ソリューション階層の異なるレベルの .editorconfig ファイルに保存できます。 これらのファイルは通常、VCS に配置され、そこで定義された設定がプロジェクトチーム間で共有されます。
JetBrains Rider では、EditorConfig を使用して、JetBrains Rider の 設定 ダイアログで利用可能な構文スタイル環境設定を定義できます。 サポートされている EditorConfig プロパティの名前と説明は、 EditorConfig リファレンスにあります。
.editorconfig ファイルで定義された構文スタイルプロパティは、この .editorconfig ファイルが適用されるスコープ内で、JetBrains Rider 設定で定義された同じプロパティをオーバーライドすることに注意することが重要です。
EditorConfig を使用して修飾子の設定を構成する
目的の .editorconfig ファイルを開きます。
必要な 修飾子プロパティをファイルに追加します。 例えば：
default_private_modifier = explicit