フォーマットルールを適用する

編集および貼り付けられたコードの自動フォーマット

エディターでコードを入力すると、JetBrains Rider はセミコロン ; を入力した時点で式を整形し、右波括弧 } を入力した時点でコードブロックを整形します。 必要に応じて、JetBrains Rider 設定 Ctrl+Alt+S の エディター | 一般 | 入力支援 ページでこれらの種類の自動フォーマットを無効化できます。

JetBrains Rider では、コードを貼り付けるときに フォーマット規則を自動的に適用することもできます。 デフォルトでは、貼り付けられたコードは完全には再フォーマットされず、インデント設定のみが適用されます。 貼り付けたコードを完全にフォーマットしたい場合や、貼り付け時のフォーマットを無効化したい場合は、JetBrains Rider 設定 Ctrl+Alt+S の エディター | 一般 | 入力支援 ページで 貼り付けで自動フォーマット セレクターを使用してください。

既存のコードを再フォーマットする

JetBrains Rider は、既存のコードを整形するためのいくつかの方法を提供します。 一言で言えば、いつも Ctrl+Alt+L を使うことができますが、以下に述べるいくつかの詳細や選択肢があります。

Alt+Enter リストから現在選択されているコードを再フォーマットできます。

または、 コードのクリーンアップを使用して、任意のスコープでコードを再フォーマットできます。 コードの再フォーマットを他のコードスタイルの適用と組み合わせる場合は、コードのクリーンアップが役立つことがあります。

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

最近変更し、Git にコミットしようとしているコードにフォーマット設定を適用できます。 JetBrains Rider は、コミットする前に選択した クリーンアッププロファイルを実行します。

変更をファイルに保存するたびにフォーマットを適用して、編集内容が常にコードスタイルに準拠していることを確認できます。 ただし、これは Ctrl+S または Ctrl+S を使用して明示的に変更を保存した場合にのみ適用され、 auto-saving ではトリガーされません。 なお、自動保存されたファイルはすべて「再フォーマットとクリーンアップ」キューに配置され、次回の明示的な保存時に処理されます。

コードインスペクションを使用して、C# および C++ のフォーマット規則を維持する

C# および C++ では、 コードインスペクション機能を利用することでコードフォーマットスタイルを維持できます。 JetBrains Rider には、デフォルトで無効化されている 数十種類のフォーマットインスペクションが用意されています。

ソリューションによっては、メソッド間でのインデントサイズの違い、switch ステートメント内の case ラベルのインデントの違い、改行の欠落など、コードベースに何百ものマイナーなフォーマット違反がある可能性があります。 これらすべての違反に対してコードインスペクションを有効にすると、うるさすぎることがあります。

一方、コードの可読性を低下させたり、コードの理解に影響を及ぼす可能性のあるフォーマットの問題があります。 例えば：

• 1 つの同じ行に複数の型メンバーがあり

• 1 行に複数のステートメント

• 子ステートメントの前後に間違ったインデントがあり

• 宣言波括弧のインデントが間違っています。

このようなフォーマットの問題については、コードインスペクションを 有効にすることをお勧めします。

既存のフォーマットを保持

一部のフォーマット規則は「ソフトに」適用できます。これは、JetBrains Rider が コード補完 や コード生成 機能を使用して新しいコードを生成したり、 コードテンプレートを適用したり、 リファクタリングを実行する際にはこれらの規則が適用されますが、 既存のコードの再フォーマット （例えば Ctrl+Alt+L の使用）を行う場合には無視されます。

フォーマット規則の厳格さを緩和するには、特定のコンテキストに対して 既存の維持 ...、 最大空白行を維持する、 シンプルラップ 設定を使用します。 JetBrains Rider 設定 Ctrl+Alt+S でこれらの環境設定の構成を確認または変更できます：

さまざまな改行スタイルでコードを再フォーマットする

JetBrains Rider では、フォーマット規則ではなく明示的なアクションを使って、類似したコードをさまざまな方法で再フォーマットすることも可能です。 これらのアクションは、 既存のフォーマットを保持するよう関連するルールを設定した場合に最も有効です。 ただし、より厳格な設定の場合、該当する明示的なフォーマットアクションは機能しません。これは、そのような構成では、影響を受ける箇所には常にフォーマット規則が適用されるためです。 例えば、 既存の維持 ... 環境設定が無効の場合、下記の wrap/chop/spacious/compact コマンドは同じ結果になります。 一部の折り返しルールが チョップ ... に設定されている場合、対応する箇所のコードは折り返しやコンパクトコマンドを実行しても必ず切り取られます。

長い行をラップしてチョップする

長い行を折り返す アクションと 長い行を切り詰める アクションは、キャレットが許可された最大行長より長い行にある場合に利用できます。この長さは 右余白 (カラム) 環境設定で、JetBrains Rider 設定 の エディター | コードスタイル | C# | 改行および折り返し ページから設定できます。 Ctrl+Alt+S。

Alt+Enter を押して、必要な改行を追加するアクションの 1 つを選択できます。

長い行を折り返す は、設定された行の長さを超えないように、十分な改行を追加します。

var reportHtml = CreateReport("359CD313-7C7E-49B2-A2AB-E12FDFD1319D", DateTimeOffset.UtcNow.AddMonths(-1), DateTimeOffset.UtcNow, useRichText: true);

var reportHtml = CreateReport("359CD313-7C7E-49B2-A2AB-E12FDFD1319D", DateTimeOffset.UtcNow.AddMonths(-1), DateTimeOffset.UtcNow, useRichText: true);

長い行を切り詰める は、ライン上の各エンティティに改行を追加します:

var reportHtml = CreateReport("359CD313-7C7E-49B2-A2AB-E12FDFD1319D", DateTimeOffset.UtcNow.AddMonths(-1), DateTimeOffset.UtcNow, useRichText: true);

var reportHtml = CreateReport("359CD313-7C7E-49B2-A2AB-E12FDFD1319D", DateTimeOffset.UtcNow.AddMonths(-1), DateTimeOffset.UtcNow, useRichText: true);

コードブロックのコンパクトで広々とした厳密なフォーマット

選択したコードを明示的に再フォーマットするための別の一連のアクションは、よりコンパクトな（改行が少ない）またはより広い（改行が多い）スタイルを適用できます。

これらのアクションを呼び出すには、コードのブロックを選択し（Ctrl+W を複数回押して論理ブロックを選択できます）、 Alt+Enter を押して 再フォーマットとクリーンアップ | 選択範囲の再フォーマット を選択します。

改行が多すぎてコードの読み取りに役立たない場合は、改行を削除することをお勧めします。 以下の例では、空の getter と setter は有用な情報をもたらさず、1 行に安全に配置できます。 これは、 コンパクトフォーマット (より少ない改行) アクションで実行できます。

public string Name { get; set; } public int Age { get; set; }

public string Name { get; set; } public int Age { get; set; }

広々としたフォーマット (チョップ) を使用すると、複数行のコードブロックを読みやすくすることができます。 例: 複雑な if 文や重い XElement コンストラクター呼び出しで改行を追加したい場合があります:

summaryTable.Add(new XElement("tr", new XElement("td", XmlHelpers.CreateHyperlink(inspection.Text, CodeInspectionHelpers.TryGetStaticHref(inspection.Id), null, true), new XComment(compoundName)), new XElement("td", GetSeverityLink(inspection.Severity))));

summaryTable.Add(new XElement("tr", new XElement("td", XmlHelpers.CreateHyperlink(inspection.Text, CodeInspectionHelpers.TryGetStaticHref(inspection.Id), null, true), new XComment(compoundName)), new XElement("td", GetSeverityLink(inspection.Severity))));

厳密なフォーマット アクションは、既存の改行を無視して選択範囲を再フォーマットします（既存の維持 ... 環境設定がどうであれ）。一方、 再インデントのみ アクションは、他のフォーマット設定を適用せずにインデントだけを修正します。