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

Code Completion in xml comments #4034

Closed
osterhoutan opened this issue Sep 2, 2020 · 6 comments
Closed

Code Completion in xml comments #4034

osterhoutan opened this issue Sep 2, 2020 · 6 comments

Comments

@osterhoutan
Copy link

XML tag Code Completion in XML Comments

Feature Request!

Add some code completion/intellisense for the supported XML tags inside of the /// comment blocks.
Hopefully also in other multi-line comment blocks the C# compiler recognizes as valid a XML documentation comment block
(supported comment blocks according to the documentation), but with the variability in what those can be & the infrequent usage they get I can understand skipping out on those.

Right now the intellisense only comes up with suggestions when in a cref=".." attribute or the like when you start typing out the name of a namespace/class/method/attribute/etc..

In fact the default code user-snippets in vscode seem to be disabled when in a comment line all together, which is odd since most language extensions still allow for user defined snippets to work in comments, but it's all in the implementation I suppose.

I have yet to see a request for this, the closest being: #8 .

@333fred
Copy link
Member

333fred commented Sep 2, 2020

This should already be implemented and fixed when the next version of the extension is published. For example, this test shows what will be available.

@333fred
Copy link
Member

333fred commented Sep 2, 2020

This is what it will look like:
image

You can try it out by installing the beta version of the extension and setting your omnisharp-path to latest: https://github.com/OmniSharp/omnisharp-vscode/wiki/Installing-Beta-Releases

@ygoe
Copy link

ygoe commented Dec 19, 2022

Has this been released by now? It's still not there.

@333fred
Copy link
Member

333fred commented Dec 19, 2022

Yes, this was released several years ago.

@ygoe
Copy link

ygoe commented Dec 19, 2022

Okay, so I'll have to create a new bug for this as it somehow got lost again.

@davidcorbin-atmosera
Copy link

Followup Question [this seems a place to anchor it... if it is already done, and I just mussed it in my search, perhaps an answer here will help others.... If not, then I can certainly create and appropriate issue...

If there any way for CoPilot to detect INCORRECT XML code comments... For example..

  1. Create a Property with Getter; Setter;
  2. Generate XML Doc Comments
  3. Remove the Setter.

The summary comment is now wrong...

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

4 participants