ReSharper 2024.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 built-in profile Built-in: 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 checkboxes, 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 by choosing this layer from the Save To selector. For more information, see manage and share resharper settings.

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

    • Place 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 to choose a profile, you can bind the default Reformat Code 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.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 in C#

Feature is available in Visual Basic

Feature is not available in C++

Feature is not available in HTML

Feature is not available in ASP.NET

Feature is not available in Razor

Feature is available in JavaScript

Feature is available in TypeScript

Feature is not available in CSS

Feature is not available in XML

Feature is not available in XAML

Feature is not available in Resource files

Feature is not available in build script files

Feature is not available in Protobuf

Feature is not available in JSON

The instructions and examples given here address the use of the feature in C#. For more information about other languages, refer to corresponding topics in the ReSharper by language section.

Last modified: 11 February 2024