Formatting of XML comments for ISymbol #18558
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Pilchie
added
Area-Compilers
Community
|
Tagging @dotnet/roslyn-compiler for review. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Viewing long plaintext XML comments using a tool like ReSharper's Ctrl+Q or DotNetApis is hard, because all the text is considered a single paragraph with no formatting.
This PR fixes that for ISymbol, but it's also a plea to reconsider the closing of #85: if even the authors of C# cannot be bothered to format their XML comments properly, what makes you think other programmers will?
cc: @MadsTorgersen