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

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

エディターでコードを入力すると、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 設定 Ctrl+Alt+S のエディター | コードスタイル | C# | 改行および折り返しページで右余白 (カラム) 設定で構成できます。

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))));

厳密な形式アクションは、既存の維持 ... 環境設定の構成方法に関係なく、既存の改行を無視して選択を再フォーマットします。再インデントのみアクションは、他のフォーマット設定を適用せずにインデントを修正します。