ReSharper 2020.2 Help

Reformat XML Doc Comments

ReSharper can reformat XML documentation comments according to your preferences.

Note that ReSharper does not reformat plain comments like:
// A plain single-line comment
or
/* A plain multi-line comment */

To reformat XML doc comments, use code cleanup. You can either run code cleanup with the default profile Default: Full Cleanup or run it with a custom profile solely targeted at your specific task.

Reformat XML doc comments with a custom Code Cleanup profile

  1. Select ReSharper | Options from the main menu or press Alt+R O.

  2. On the Code Editing | XML Doc Comments | Formatting Style page, configure formatting settings so that they comply with your coding practices or standards.

  3. Go to the cleanup profiles settings page: Code Editing | Code Cleanup | Profiles.

  4. Create a new profile as described in the Create a new custom cleanup profile section. In the Selected profile settings section for the new profile, select the Reformat embedded XML doc comments check boxes, which are available for C#, VB.NET, and JavaScript. Optionally, you can enable other code cleanup tasks in this profile.

  5. Click Save in the Options dialog to apply the modifications and let ReSharper choose where to save them, or save the modifications to a specific settings layer using the Save To list. For more information, see Manage and Share ReSharper Settings.

  6. Select the scope where you want to reformat XML doc comments:

    • Set the caret anywhere in the file to reformat XML doc comments to the file.

    • Select one or more items in the Solution Explorer to reformat XML doc comments in the files under these nodes and their child items.

  7. Do one of the following:

    • Press Control+Alt+F or choose ReSharper | Edit | Cleanup Code... from the main menu .

    • Right-click anywhere in the text editor or right-click the selection and choose Cleanup Code in the context menu.

  8. In the Code Cleanup dialog that opens, select the newly created profile.

  9. Click Run. ReSharper will reformat XML doc comments in the selected scope.

If you want to reformat XML doc comments without opening the Code Cleanup dialog, you can bind the created profile to the silent cleanup and run it by pressing Control+Shift+Alt+F. You can also create a custom cleanup profile that would combine reformatting XML doc comments with other code style tasks.

This feature is supported in the following languages and technologies:

Language: C#Language: VB.NETLanguage: C++Language: HTMLLanguage: ASP.NETLanguage: RazorLanguage: JavaScriptLanguage: TypeScriptLanguage: CSSLanguage: XMLLanguage: XAMLLanguage: ResxLanguage: Build ScriptsLanguage: ProtobufLanguage: JSON
Feature is available in C#Feature is available in Visual Basic .NETFeature is not available in C++Feature is not available in HTMLFeature is not available in ASP.NETFeature is not available in RazorFeature is available in JavaScriptFeature is available in TypeScriptFeature is not available in CSSFeature is not available in XMLFeature is not available in XAMLFeature is not available in Resource filesFeature is not available in build script filesFeature is not available in ProtobufFeature is not available in JSON

The instructions and examples given here address the use of the feature in C#. For details specific to other languages, see corresponding topics in the ReSharper by Language section.

Last modified: 21 August 2020