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

Enhanced C# XML comment extension. #43710

Open
vsfeedback opened this issue Apr 27, 2020 · 6 comments
Open

Enhanced C# XML comment extension. #43710

vsfeedback opened this issue Apr 27, 2020 · 6 comments
Labels
Area-IDE Developer Community The issue was originally reported on https://developercommunity.visualstudio.com Feature Request Need Design Review The end user experience design needs to be reviewed and approved.
Milestone

Comments

@vsfeedback
Copy link

vsfeedback commented Apr 27, 2020

This issue has been moved from a ticket on Developer Community.


When typing /// on a proper place VS expands this to an XML <summary></summary> tag in the form of

/// <summary>
/// |
/// </summary>

For field and properties or everything else most developers would prefer a single line for the summary:

/// <summary>|</summary>

It would be nice to have the possibility to switch this to a one liner in the settings or maybe convert the 3 line code to a single line when the user directly presses the backspace key right after the expansion.

Thank you for your attention.


Original Comments

Visual Studio Feedback System on 3/10/2020, 10:51 PM:

We have directed your feedback to the appropriate engineering team for further evaluation. The team will review the feedback and notify you about the next steps.

Visual Studio Feedback System on 4/23/2020, 09:25 PM:

I have detected that for the last 35 days, this issue didn't have much product team activity and a very small amount of new votes or comments. Based on this, its severity, and affected area, it’s my experience that this issue is very unlikely to be fixed.


Original Solutions

(no solutions)

@jinujoseph jinujoseph added Area-IDE Developer Community The issue was originally reported on https://developercommunity.visualstudio.com Feature Request Need Design Review The end user experience design needs to be reviewed and approved. labels Apr 28, 2020
@jinujoseph jinujoseph added this to the Backlog milestone Apr 28, 2020
@zombeek
Copy link

zombeek commented May 28, 2020

For this one-liners, it would be even better just
/// description

@sharwell
Copy link
Member

@zombeek that case looks closely related to dotnet/csharplang#2394 (comment)

@dmccarty-incomm
Copy link

I don't need the IDE to try and do any sort of fancy detection on what I am adding the XML documentation to -- I just want a single option to have it ALWAYS either do the current, 3-line version OR this new, single line version (and I would have it always do the single line version).

@sharwell
Copy link
Member

@David-McCarty it may be possible to change this behavior using a relatively simple extension for Visual Studio. If you ping me here next week I can take a look.

@dmccarty-incomm
Copy link

It may be possible to change this behavior using a relatively simple extension for Visual Studio.

It is--GhostDoc is able to modify this behavior. I hadn't considered the possibility of writing my own extension to do that--it's a good idea.

@sgf
Copy link

sgf commented Jan 12, 2024

I almost always manually change it to one line, because the size of the screen window is limited, and too many comment lines really affect the reading of the context.
Of course I only do this for three lines of comments.

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 Need Design Review The end user experience design needs to be reviewed and approved.
Projects
Status: In Queue
Development

No branches or pull requests

6 participants