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

Type parameters XML doc tags not shown properly in Intellisense #3516

Closed
ChrRubin opened this issue Jan 18, 2020 · 5 comments · Fixed by OmniSharp/omnisharp-roslyn#1749
Closed

Comments

@ChrRubin
Copy link

Issue Description

When using the <typeparam> XML doc tag, its description is shown without preceding with a new-line nor its name.

Steps to Reproduce

Add the <typeparam> tag to the XML doc comment of a class or method that accepts generic types.

Expected Behavior

Type parameters should be shown just like normal parameters with the <param> tag, each on a new line with their name followed by its description.

Actual Behavior

Only the description of <typeparam> is shown on the same line with <param>.
image

If multiple <typeparam> tags are used they are all shown on the same line.
image

Environment information

VSCode version: 1.41.1
C# Extension: 1.21.9

Dotnet Information .NET Core SDK (reflecting any global.json): Version: 3.0.101 Commit: bc5f8df0f5

Runtime Environment:
OS Name: Windows
OS Version: 10.0.17763
OS Platform: Windows
RID: win10-x64
Base Path: C:\Program Files\dotnet\sdk\3.0.101\

Host (useful for support):
Version: 3.0.1
Commit: 32085cbc72

.NET Core SDKs installed:
3.0.101 [C:\Program Files\dotnet\sdk]

.NET Core runtimes installed:
Microsoft.AspNetCore.App 3.0.1 [C:\Program Files\dotnet\shared\Microsoft.AspNetCore.App]
Microsoft.NETCore.App 3.0.1 [C:\Program Files\dotnet\shared\Microsoft.NETCore.App]
Microsoft.WindowsDesktop.App 3.0.1 [C:\Program Files\dotnet\shared\Microsoft.WindowsDesktop.App]

To install additional .NET Core runtimes or SDKs:
https://aka.ms/dotnet-download

@ChrRubin
Copy link
Author

Also it is worth noting that <typeparamref> is completely ignored:
image

@ChrRubin ChrRubin changed the title Type parameters not shown properly in Intellisense Type parameters XML doc tags not shown properly in Intellisense Jan 18, 2020
@DanielLidstromTicket
Copy link

I am seeing other problems with xml comments. I am not sure if there are other issues for those, but I am seeing showing up garbled in intellisense. Please let me know if there is an issue already or if I should create a new, or amend this. Thanks!

@JoeRobich
Copy link
Member

@DanielLidstromTicket Can you please open an issue for the intellisense issues you are seeing?

@DanielLidstromTicket
Copy link

I did here: #3693

@JoeRobich
Copy link
Member

This issue is fixed in 1.21.17

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

Successfully merging a pull request may close this issue.

3 participants