roslyn
roslyn copied to clipboard
Style: Decrease number of lines for default <summary> element in XML comments
Version Used: Visual Studio 2015
Steps to Reproduce:
- Open a code file.
- Type three slashes to start an xml comment
Expected Behavior:
/// <summary>|</summary>
Actual Behavior:
/// <summary>
/// |
/// </summary>
I would prefer it, if the default behavior when creating xml documents would create 1 line instead of 3 lines.
The reasons being:
- It would cut down the size of single line comments by 2/3, which is a 66% saving.
- Single line comments are a major use case as they are fairly common, e.g. for properties, most simple methods.
- Even in the case that you want a multi-line comment you can simply hit enter like you already do.
- Consistent with other xml documentation elements, e.g. 'returns' or 'params'
Take care, Martin