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

C# IntelliSense does not respect newlines in doc comments #26503

Closed
vsfeedback opened this issue Apr 30, 2018 · 3 comments
Closed

C# IntelliSense does not respect newlines in doc comments #26503

vsfeedback opened this issue Apr 30, 2018 · 3 comments
Labels
Area-IDE Developer Community The issue was originally reported on https://developercommunity.visualstudio.com Feature Request Resolution-By Design The behavior reported in the issue matches the current design
Milestone

Comments

@vsfeedback
Copy link

For any long "summary" comment, hovering over the type/method seems to strip all newlines.
This makes it very difficult to read if you have a long/verbose comment.

Using "para" isn't really much of an option as:

  1. It adds 2 newlines (not just 1)
  2. I don't want to have to add "para" open and close tags everywhere.

This issue has been moved from https://developercommunity.visualstudio.com/content/problem/239537/c-intellisense-does-not-respect-newlines-in-doc-co.html
VSTS ticketId: 605850

These are the original issue comments:
(no comments)
These are the original issue solutions:
(no solutions)

@jinujoseph jinujoseph added Bug Area-IDE Developer Community The issue was originally reported on https://developercommunity.visualstudio.com labels Apr 30, 2018
@sharwell
Copy link
Member

sharwell commented Apr 30, 2018

This is normal behavior in XML. Changing the behavior is likely to negatively impact the experience for developers who expect the XML to behave as it currently does. However, we might consider reducing the size of the paragraph-separating space that appears when <para> elements are used.

Additional notes:

@jinujoseph jinujoseph added Developer Community The issue was originally reported on https://developercommunity.visualstudio.com and removed Developer Community The issue was originally reported on https://developercommunity.visualstudio.com labels Jun 18, 2018
@jinujoseph jinujoseph added this to the Unknown milestone Jun 19, 2018
@jinujoseph jinujoseph added Need Design Review The end user experience design needs to be reviewed and approved. Feature Request Resolution-By Design The behavior reported in the issue matches the current design and removed Bug labels Jun 19, 2018
@jinujoseph
Copy link
Contributor

Tentatively marking as By Design
We will taking this for review and will update with final conclusion.

@sharwell
Copy link
Member

Today's design review confirmed that this behavior is By Design according to the current definition of the language. Note that it may be possible to implement an analyzer that inserts the <para> elements. I don't know of one that's readily available today, but you may be interested in openstacknetsdk/OpenStackNetAnalyzers#18 and/or DotNetAnalyzers/StyleCopAnalyzers#610 as a starting point.

@sharwell sharwell removed the Need Design Review The end user experience design needs to be reviewed and approved. label Aug 13, 2018
@sharwell sharwell moved this to Complete in IDE: Design review Aug 22, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Area-IDE Developer Community The issue was originally reported on https://developercommunity.visualstudio.com Feature Request Resolution-By Design The behavior reported in the issue matches the current design
Projects
Archived in project
Development

No branches or pull requests

3 participants