コードの構文スタイル: 空の文字列
C# では、空の文字列は、空のリテラル "" または string.Empty プロパティのいずれかを使用して割り当てることができます。 JetBrains Rider では、空の文字列のスタイルを指定し、目的のスコープでこのスタイルを強制できます。
JetBrains Rider は、既存のコードに空文字列スタイルを適用し、新しいコードを コード補完や コード生成機能で生成する際に環境設定を考慮し、 コードテンプレートを適用し、 リファクタリングも実行します。
空の文字列にスタイル設定を適用する
デフォルトでは、JetBrains Rider は空リテラル "" の使用を推奨し、 string.Empty プロパティの利用箇所を報告します。このような利用箇所は ハイライトされ、対応する クイックフィックスまたは スコープ内修正を提案します。
string.Empty プロパティを好む場合は、 環境設定で設定でき、JetBrains Rider がその環境設定を適用する手助けをします：
一括処理で空文字列の優先順位を強制するもう 1 つの方法は、 コードクリーンアップです。 組み込みプロファイル フルクリーンアップまたは 再フォーマットして構文スタイルを適用のいずれかを使用して コードクリーンアップを実行するか、後述するように、特定のタスクのみを対象とした カスタムプロファイルを作成して実行することができます。
カスタムコードクリーンアッププロファイルで空文字列スタイルを適用する
Ctrl+Alt+S を押すか、メニューから (Windows および Linux) または (macOS) を選択します。
クリーンアッププロファイル設定ページに移動します: 。
新しいカスタムクリーンアッププロファイルを作成する セクションの説明に従って、新しいプロファイルを作成します。 右側のプロファイル設定で、 ノードを展開し、 空の sring スタイルを適用する チェックボックスをオンにします。
設定 ダイアログで 保存 をクリックして変更を適用し、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 の ページに移動し、 構文スタイル タブを選択します。
空の文字列 カテゴリでは、コーディングの慣習 / 基準に応じて string.Empty または 空のリテラル "" を選択してください。
右列のセレクターを使うと、環境設定と異なるコードを検出する コードインスペクションの 重要度レベルを設定できます。
設定 ダイアログで 保存 をクリックして変更を適用し、JetBrains Rider が保存先を選択できるようにするか、 保存 セレクターからレイヤーを選んで特定の設定レイヤーに変更を保存します。 詳細については、「レイヤーベースの設定 」を参照してください。
また、関連する問題がハイライトされているエディター内で、空文字列の環境設定を直接変更することもできます：
エディターから空文字列の設定を変更する
JetBrains Rider のインスペクションでハイライトされているコードの問題にキャレットを置きます。
Alt+Enter を押すか、キャレットの左にある アクションインジケーターをクリックして、 アクションリストを開きます。
アクション一覧から インスペクション「空文字列スタイル」 | コードスタイルを設定する を選択し、次に希望するオプションを選択してください。
変更は、 スマートセーブロジックを使用して保存されます。
変更したスタイル環境設定を 共有設定レイヤーに保存したい場合は、 コードスタイルを設定する メニュー項目をクリックするか、選択されているときに Enter を押します。 JetBrains Rider は 設定 の ページを開き、必要に応じて環境設定を変更できます。 保存先 をクリックし、希望する設定レイヤーを選択してください。
EditorConfig を介して構文スタイルの設定を行うことができます。 これらの設定は、ソリューション階層の異なるレベルの .editorconfig ファイルに保存できます。 これらのファイルは通常、VCS に配置され、そこで定義された設定がプロジェクトチーム間で共有されます。
JetBrains Rider では、EditorConfig を使用して、JetBrains Rider の 設定 ダイアログで利用可能な構文スタイル環境設定を定義できます。 サポートされている EditorConfig プロパティの名前と説明は、 EditorConfig リファレンスにあります。
.editorconfig ファイルで定義された構文スタイルプロパティは、この .editorconfig ファイルが適用されるスコープ内で、JetBrains Rider 設定で定義された同じプロパティをオーバーライドすることに注意することが重要です。
EditorConfig を使用して、空文字列スタイルの設定を変更する
目的の .editorconfig ファイルを開きます。
必要な 空文字列スタイルプロパティをファイルに追加します。 例えば：
resharper_empty_string = string_empty