JetBrains Rider 2024.1 Help

Reformat XML Doc comments

JetBrains Rider can reformat XML documentation comments according to your preferences.

Note that JetBrains Rider 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 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. Press Ctrl+Alt+S or choose File | Settings (Windows and Linux) or JetBrains Rider | Preferences (macOS) from the menu .

  2. On the Editor | Code Style | C# | XML Documentation page, configure formatting settings so that they comply with your coding practices or standards.

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

  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 Settings dialog to apply the modifications and let JetBrains Rider choose where to save them, or save the modifications to a specific settings layer by choosing this layer from the Save selector. For more information, see layer-based 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. Press Ctrl+R, C or choose Code | Reformat and Cleanup… from the main menu .

  8. In the Reformat and Cleanup Code dialog that opens, select the newly created profile and choose another scope if needed. .

  9. Click OK. JetBrains Rider will reformat XML doc comments in the selected scope.

If you want to reformat XML doc comments without opening the Reformat and Cleanup Code dialog to choose a profile, you can bind the default Reformat Code profile to the silent cleanup and run it by pressing Ctrl+R, G. You can also create a custom cleanup profile that would combine reformatting XML doc comments with other code style tasks.

Last modified: 11 February 2024