Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix xmldoc #1591

Merged
merged 2 commits into from
Aug 8, 2019
Merged

Fix xmldoc #1591

merged 2 commits into from
Aug 8, 2019

Conversation

RussKie
Copy link
Member

@RussKie RussKie commented Aug 8, 2019

Fixes #

Proposed changes

  • Purely cosmetic change that increases xml-doc spacing to 2 after ///.
    The increased spacing makes it slightly easier to read the comments in the code.
    The change is done in VS using regex ///\s([^< ]) -> /// $1
  • Fix and add xml-doc

Customer Impact

  • None

Regression?

  • No

Risk

  • None
Microsoft Reviewers: Open in CodeFlow

Purely cosmetic change that increases xml-doc spacing to 2 after `///`.
The increased spacing makes it slightly easier to read the comments in
the code.

The change is done in VS using regex `///\s([^< ])` -> `///  $1`
@RussKie RussKie requested a review from a team as a code owner August 8, 2019 12:16
@RussKie RussKie merged commit ab6730e into dotnet:master Aug 8, 2019
@ghost ghost added this to the 3.0.0-Preview9 milestone Aug 8, 2019
@ghost ghost added the tell-mode label Aug 8, 2019
@RussKie RussKie deleted the fix_xmldoc branch August 8, 2019 12:32
@sharwell
Copy link
Member

sharwell commented Aug 8, 2019

increases xml-doc spacing to 2

Oh what has happened 🤕

@sharwell
Copy link
Member

sharwell commented Aug 8, 2019

The increased spacing makes it slightly easier to read the comments in the code.

I would suggest changing the color of XML elements in documentation comments instead of changing to a non-standard and non-maintainable layout. I use the following in my vssettings:

<Item Name="xml doc comment - name" Foreground="0x0067A8C7" Background="0x02000000" BoldFont="No"/>
<Item Name="xml doc comment - entity reference" Foreground="0x004E8B60" Background="0x02000000" BoldFont="Yes"/>
<Item Name="xml doc comment - delimiter" Foreground="0x0067A8C7" Background="0x02000000" BoldFont="No"/>
<Item Name="xml doc comment - attribute name" Foreground="0x006968A6" Background="0x02000000" BoldFont="No"/>

image

@RussKie
Copy link
Member Author

RussKie commented Aug 8, 2019

increases xml-doc spacing to 2

Oh what has happened 🤕

#1489 guideline:2

I use the following in my vssettings:

Thank you Sam.
However a number of our contributors do not use VS, and thus these settings won't work for everyone.

@weltkante
Copy link
Contributor

The change is done in VS using regex ///\s([^< ]) -> /// $1

You might want to anchor the regex at the start of the line, allowing only whitespace up to the comment, otherwise you'll also update triple slashes inside strings (even with anchoring it could still be a multiline string though).

@ghost ghost locked as resolved and limited conversation to collaborators Feb 5, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants