XML ドキュメントコメントを再フォーマットする
JetBrains Rider はお好みに合わせて XML ドキュメントコメントを整形できます。
JetBrains Rider は次のようなプレーンコメントを整形しないことに注意してください:
または
XML ドキュメントコメントを再フォーマットするには、 コードクリーンアップを使用します。 組み込みプロファイル Built-in: Full Cleanupを使って コードのクリーンアップを実行するか、特定のタスクだけをターゲットとしたカスタムプロファイルで実行できます。
カスタムコードクリーンアッププロファイルを使用して XML ドキュメントコメントを再フォーマットする
Ctrl+Alt+S を押すか、メニューから (Windows および Linux) または (macOS) を選択します。
ページで、あなたのコーディング慣行や標準に準拠するようにフォーマット設定を構成します。
クリーンアッププロファイル設定ページに移動します: 。
新しいカスタムクリーンアッププロファイルを作成する セクションの説明に従って、新しいプロファイルを作成します。 右側のプロファイル設定で、 ノードを展開し、目的の言語(C#、Visual Basic .NET、または JavaScript/TypeScript)のノードを展開して、 埋め込み XML ドキュメントコメントを整形する を選択します。
設定 ダイアログで 保存 をクリックして変更を適用し、JetBrains Rider が保存先を選択できるようにするか、 保存 セレクターからレイヤーを選んで特定の設定レイヤーに変更を保存します。 詳細については、「レイヤーベースの設定 」を参照してください。
XML 文書のコメントを再フォーマットする範囲を選択します。
XML ドキュメントコメントをファイルに再フォーマットするには、ファイル内の任意の場所にキャレットを置きます。
ソリューションエクスプローラー の 1 つまたは複数の項目を選択して、これらのノードおよびその子項目にあるファイル内の XML 文書コメントを再フォーマットします。
Ctrl+R, C を押すか、メインメニューから を選択してください。
表示された 整形とクリーンアップ ダイアログで、新しく作成したプロファイルを選択し、必要なら別のスコープを選択してください。 。
OK をクリックします。 JetBrains Rider は、選択したスコープ内の XML ドキュメントコメントを整形します。
整形とクリーンアップ ダイアログを開いてプロファイルを選ばずに XML ドキュメントコメントを整形したい場合、デフォルトの コードの整形プロファイルを サイレントクリーンアップにバインドし、 Ctrl+R, G を押して実行できます。 XML ドキュメントコメントの再フォーマットと他のコードスタイルタスクを組み合わせた カスタムクリーンアッププロファイルを作成することもできます。