コードの構文スタイル: 末尾のコンマ
複数の項目がコンマ（オブジェクト、配列、コレクション初期化子、列挙型および switch 式）で区切られている場合、C# を使用すると、最後の項目の 後にコンマを付けることができます。
var list = new List<string>
{
"one",
"two"
};
|
var list = new List<string>
{
"one",
"two", // trailing comma
};
|
JetBrains Rider は、既存のコードの末尾のコンマの整理をサポートし、新規コードを コード補完 や コード生成 機能で生成する際に、環境設定を考慮します。また、 コードテンプレート を適用し、 リファクタリング を実行します。
末尾のコンマを優先する
デフォルトでは、JetBrains Rider は末尾のコンマを冗長なものとしてハイライトし、削除をサポートします：
コードで末尾のコンマを好む場合は、 対応する環境設定を変更できます。JetBrains Rider が不足している末尾のコンマの追加をサポートします：
バルクモードで末尾のコンマの環境設定を適用する別のオプションは、 コードのクリーンアップ です。 組み込みプロファイル フルクリーンアップまたは 再フォーマットして構文スタイルを適用のいずれかを使用して コードクリーンアップを実行するか、後述するように、特定のタスクのみを対象とした カスタムプロファイルを作成して実行することができます。
カスタムコードクリーンアッププロファイルで末尾のコンマスタイルを適用する
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 設定で設定を構成する
JetBrains Rider 設定 Ctrl+Alt+S の ページに移動し、 構文スタイル タブを選択します。
末尾のコンマ カテゴリで、単一行または複数行の宣言で末尾のコンマを優先するかどうかを指定します。
右列のセレクターを使うと、環境設定と異なるコードを検出する コードインスペクションの 重要度レベルを設定できます。
設定 ダイアログで 保存 をクリックして変更を適用し、JetBrains Rider が保存先を選択できるようにするか、 保存 セレクターからレイヤーを選んで特定の設定レイヤーに変更を保存します。 詳細については、「レイヤーベースの設定 」を参照してください。
EditorConfig を介して構文スタイルの設定を行うことができます。 これらの設定は、ソリューション階層の異なるレベルの .editorconfig ファイルに保存できます。 これらのファイルは通常、VCS に配置され、そこで定義された設定がプロジェクトチーム間で共有されます。
JetBrains Rider では、EditorConfig を使用して、JetBrains Rider の 設定 ダイアログで利用可能な構文スタイル環境設定を定義できます。 サポートされている EditorConfig プロパティの名前と説明は、 EditorConfig リファレンスにあります。
.editorconfig ファイルで定義された構文スタイルプロパティは、この .editorconfig ファイルが適用されるスコープ内で、JetBrains Rider 設定で定義された同じプロパティをオーバーライドすることに注意することが重要です。
EditorConfig を使用して末尾のコンマスタイルの設定を構成する
目的の .editorconfig ファイルを開きます。
必要な 末尾のコンマスタイルのプロパティをファイルに追加します。 例えば：
trailing_comma_in_multiline_lists = false