ReSharper 2018.3ヘルプ

XMLドキュメントコメントの再フォーマット

ReSharperはあなたの好みに従ってXMLドキュメントのコメント(英語)を再フォーマットすることができます。

ReSharperは次のような単純なコメントを再フォーマットしないことに注意してください:
// A plain single-line comment
または
/* A plain multi-line comment */

XML文書コメントを再フォーマットするには、コードクリーンアップを使用します。デフォルトのプロファイルデフォルト: フルクリーンアップコードクリーンアップを実行するか、特定のタスクのみを対象とするカスタムプロファイルでコードクリーンアップを実行することができます。

カスタムコードクリーンアッププロファイルでXML文書のコメントを再フォーマットするには

  1. メインメニューでReSharper | オプションを選択します。

  2. ReSharperオプションのコード編集 | XML文書コメント | スタイルの書式設定ページで、コーディングプラクティスまたは標準に準拠するようにフォーマット設定を構成します。

  3. コードクリーンアップの設定ページコード編集 | コードのクリーンアップに移動します。

  4. 新しいカスタムクリーンアッププロファイルを作成するにはセクションの説明に従って、新しいプロファイルを作成します。新しいプロファイルの選択したプロファイル設定セクションで、C#、VB.NET、およびJavaScriptで使用可能な埋め込みXMLドキュメントコメントの再フォーマットチェックボックスを選択します。必要に応じて、このプロファイルで他のコードクリーンアップタスクを有効にすることができます。

  5. 保存をクリックして変更を適用し、ReSharperに変更を保存する場所を選択させるか、次へ保存ドロップダウンリストを使用して変更を特定の設定レイヤーに保存します。詳細については、「 resharper設定の管理と共有 」を参照してください。

  6. XML文書のコメントを再フォーマットする範囲を選択します。
    • XML文書のコメントをファイルに再フォーマットするには、ファイルのどこにでもキャレットを設定します。

    • ソリューション・エクスプローラーの1つまたは複数の項目を選択して、これらのノードおよびその子項目にあるファイル内のXML文書コメントを再フォーマットします。

  7. 以下のいずれか 1 つを実行します:
    • Ctrl+Alt+F を押すか、メインメニューからReSharper | 編集 | コードのクリーンアップを選択してください。

    • テキストエディターの任意の場所を右クリックするか、選択項目を右クリックし、コンテキストメニューでコードのクリーンアップを選択します。

  8. 開いているコードクリーンアップダイアログで、新しく作成したプロファイルを選択します。

  9. 実行をクリックします。ReSharperは、選択したスコープ内のXML文書コメントを再フォーマットします。

コードクリーンアップダイアログを開かずにXMLドキュメントのコメントを再フォーマットする場合は、作成したプロファイルをサイレントクリーンアップにバインドし、Ctrl+Shift+Alt+Fを押すだけで実行できます。また、XML文書の再フォーマットのコメントと他のコードスタイルのタスクを組み合わせるカスタムのクリーンアッププロファイルを作成することもできます。

この機能は、次の言語とテクノロジでサポートされています。

Language: C#

Language: VB.NET

Language: C++

Language: HTML

Language: ASP.NET

Language: Razor

Language: JavaScript

Language: TypeScript

Language: CSS

Language: XML

Language: XAML

Language: Resx

Language: Build Scripts

Language: Protobuf

Language: JSON

Feature is available

Feature is available

Feature is not available

Feature is not available

Feature is not available

Feature is not available

Feature is available

Feature is available

Feature is not available

Feature is not available

Feature is not available

Feature is not available

Feature is not available

Feature is not available

Feature is not available

C#の機能の使用方法については、こちらの説明と例を参照してください。他言語の詳細については、言語によるReSharperの対応するトピックを参照してください。

最終更新日: 2019年3月21日

関連事項