ReSharper 2017.1 Help

Reformatting 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
/* 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 the cleanup with a custom profile solely targeted at your specific task as described below.

To reformat XML doc comments with Code Cleanup

  1. Choose ReSharper | Options in the main menu.
  2. On the Code Editing | XML Doc Comments | Formatting Style page of ReSharper options, 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 the Code Cleanup section. In the Selected profile settings section for the new profile, tick the Reformat embedded XML doc comments check box.
  5. Click Save 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 drop-down list. For more information, see Managing and Sharing 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 Ctrl+Alt+F or choose ReSharper | Edit | Cleanup Code in 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 simply by pressing Ctrl+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/technologies:

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: 12 October 2017

See Also