ReSharper Web Help

ReSharper can reformat XML doc comments in C#, VB.NET, and JavaScript code according to your settings.

Note

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

To reformat XML doc comments with Code Cleanup
  1. Choose ReSharper | Options in the main menu.
  2. In the ReSharper | Options | Code Editing | XML Doc Comments | Formatting Style, configure formatting settings so that they comply with your coding practices/standards.
  3. Open the Code Cleanup options: ReSharper | Options | Code Editing | Code Cleanup.
  4. Create a new profile as described in Creating Custom Profiles. In the Selected profile settings for the new profile, select Reformat embedded XML doc comments in the desired language categories (C#, VB.NET, JavaScript).
  5. Click Save to apply the modifications and let ReSharper choose the settings layer, or choose a particular settings layer in the Save To drop-down list. To learn more about saving ReSharper settings, see JetBrains .NET Tools Blog: Save or Save To in ReSharper Options.
  6. Choose ReSharper | Tools | Cleanup Code in the menu to open the Code Cleanup dialog box for the current file or for a solution node (see Running Code Cleanup for details), and then select the newly created profile in the Available Profiles area.
  7. Click Run to perform Code Cleanup. ReSharper will reformat XML doc comments in your selection, file, directory, project, or solution (depending on how you chose to run Code Cleanup) and according to your settings.

This feature is supported in the following languages/technologies:

C# VB.NET HTML ASPX Razor JavaScript TypeScript CSS XML XAML RESX Build Scripts
feature_available feature_available feature_available feature_available

Tip

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