Reformat XML Doc comments
Last modified: 21 July 2022ReSharper can reformat XML documentation comments according to your preferences.
Note that ReSharper does not reformat plain comments like:
// A plain single-line commentor
/* 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
Select ReSharper | Options from the main menu or press Alt+R O.
On the Code Editing | XML Doc Comments | Formatting Style page, configure formatting settings so that they comply with your coding practices or standards.
Go to the cleanup profiles settings page: Code Editing | Code Cleanup | Profiles.
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.
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.
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.
Do one of the following:
Press Ctrl+E C 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.
In the Code Cleanup dialog that opens, select the newly created profile .
Click Run. ReSharper will reformat XML doc comments in the selected scope.
note
Code cleanup is not applied to generated code. By default, ReSharper provides the list of file masks and regions for generated code typically produced by Visual Studio (for example, Windows Form Designer-generated code). If necessary, you can edit the list of generated items on the Code Inspection | Generated Code page of ReSharper options (Alt+R, O).
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 Ctrl+E 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:
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
| | | | |
|
| | | | | | | |
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.