vscode-csharp icon indicating copy to clipboard operation
vscode-csharp copied to clipboard

Published 20 hours ago • verified publisher icon dotnet

<param> Doc Comments Aren't in Tooltip

Open colejohnson66 opened this issue 3 years ago • 9 comments

Issue Description

As the title shows, <param> doc comments don't show in the tooltip.

Steps to Reproduce

Write an XML doc comment using <param> tags.

Expected Behavior

The <param> tags show up.

Actual Behavior

As shown:

Logs

OmniSharp log

Starting OmniSharp server at 2/19/2022, 8:42:49 PM Target: c:\Users\Cole\Desktop\Projects\HyperText\HyperText.sln

OmniSharp server started. Path: c:\Users\Cole.vscode\extensions\ms-dotnettools.csharp-1.24.0.omnisharp\1.38.0\OmniSharp.exe PID: 8968

Starting OmniSharp on Windows 6.2.9200.0 (x64) info: OmniSharp.Services.DotNetCliService Checking the 'DOTNET_ROOT' environment variable to find a .NET SDK info: OmniSharp.Services.DotNetCliService Using the 'dotnet' on the PATH. info: OmniSharp.Services.DotNetCliService DotNetPath set to dotnet info: OmniSharp.MSBuild.Discovery.MSBuildLocator Located 2 MSBuild instance(s) 1: Visual Studio Community 2022 17.1.32210.238 17.1.0 - "C:\Program Files\Microsoft Visual Studio\2022\Community\MSBuild\Current\Bin" 2: StandAlone 17.0.0 - "c:\Users\Cole.vscode\extensions\ms-dotnettools.csharp-1.24.0.omnisharp\1.38.0.msbuild\Current\Bin" info: OmniSharp.MSBuild.Discovery.MSBuildLocator Registered MSBuild instance: Visual Studio Community 2022 17.1.32210.238 17.1.0 - "C:\Program Files\Microsoft Visual Studio\2022\Community\MSBuild\Current\Bin" info: OmniSharp.WorkspaceInitializer Invoking Workspace Options Provider: OmniSharp.Roslyn.CSharp.Services.CSharpFormattingWorkspaceOptionsProvider, Order: 0 info: OmniSharp.WorkspaceInitializer Invoking Workspace Options Provider: OmniSharp.Roslyn.CSharp.Services.Completion.CompletionOptionsProvider, Order: 0 info: OmniSharp.WorkspaceInitializer Invoking Workspace Options Provider: OmniSharp.Roslyn.CSharp.Services.RenameWorkspaceOptionsProvider, Order: 100 info: OmniSharp.WorkspaceInitializer Invoking Workspace Options Provider: OmniSharp.Roslyn.CSharp.Services.ImplementTypeWorkspaceOptionsProvider, Order: 110 info: OmniSharp.WorkspaceInitializer Invoking Workspace Options Provider: OmniSharp.Roslyn.CSharp.Services.BlockStructureWorkspaceOptionsProvider, Order: 140 info: OmniSharp.Cake.CakeProjectSystem Detecting Cake files in 'c:\Users\Cole\Desktop\Projects\HyperText'. info: OmniSharp.Cake.CakeProjectSystem Did not find any Cake files info: OmniSharp.MSBuild.ProjectSystem Detecting projects in 'c:\Users\Cole\Desktop\Projects\HyperText\HyperText.sln'. info: OmniSharp.MSBuild.ProjectManager Queue project update for 'c:\Users\Cole\Desktop\Projects\HyperText\AngleBracket\AngleBracket.csproj' info: OmniSharp.MSBuild.ProjectManager Queue project update for 'c:\Users\Cole\Desktop\Projects\HyperText\AngleBracket.Test\AngleBracket.Test.csproj' info: OmniSharp.MSBuild.ProjectManager Queue project update for 'c:\Users\Cole\Desktop\Projects\HyperText\CodePoint\CodePoint.csproj' info: OmniSharp.MSBuild.ProjectManager Queue project update for 'c:\Users\Cole\Desktop\Projects\HyperText\CodePoint.Test\CodePoint.Test.csproj' info: OmniSharp.MSBuild.ProjectManager Queue project update for 'c:\Users\Cole\Desktop\Projects\HyperText\CurlyBracket\CurlyBracket.csproj' info: OmniSharp.MSBuild.ProjectManager Queue project update for 'c:\Users\Cole\Desktop\Projects\HyperText\CurlyBracket.Test\CurlyBracket.Test.csproj' info: OmniSharp.MSBuild.ProjectManager Queue project update for 'c:\Users\Cole\Desktop\Projects\HyperText\FiberWire\FiberWire.csproj' info: OmniSharp.MSBuild.ProjectManager Queue project update for 'c:\Users\Cole\Desktop\Projects\HyperText\FiberWire.Test\FiberWire.Test.csproj' info: OmniSharp.MSBuild.ProjectManager Queue project update for 'c:\Users\Cole\Desktop\Projects\HyperText\HyperText\HyperText.csproj' info: OmniSharp.MSBuild.ProjectManager Queue project update for 'c:\Users\Cole\Desktop\Projects\HyperText\StyleSheet\StyleSheet.csproj' info: OmniSharp.MSBuild.ProjectManager Queue project update for 'c:\Users\Cole\Desktop\Projects\HyperText\StyleSheet.Test\StyleSheet.Test.csproj' info: OmniSharp.MSBuild.ProjectManager Queue project update for 'c:\Users\Cole\Desktop\Projects\HyperText\Jint\Jint.csproj' info: OmniSharp.Script.ScriptProjectSystem Detecting CSX files in 'c:\Users\Cole\Desktop\Projects\HyperText'. info: OmniSharp.MSBuild.ProjectManager Loading project: c:\Users\Cole\Desktop\Projects\HyperText\AngleBracket\AngleBracket.csproj info: OmniSharp.Script.ScriptProjectSystem Did not find any CSX files info: OmniSharp.WorkspaceInitializer Configuration finished. info: OmniSharp.Stdio.Host Omnisharp server running using Stdio at location 'c:\Users\Cole\Desktop\Projects\HyperText' on host 17160. info: OmniSharp.MSBuild.ProjectManager Successfully loaded project file 'c:\Users\Cole\Desktop\Projects\HyperText\AngleBracket\AngleBracket.csproj'. info: OmniSharp.MSBuild.ProjectManager Adding project 'c:\Users\Cole\Desktop\Projects\HyperText\AngleBracket\AngleBracket.csproj' info: OmniSharp.MSBuild.ProjectManager Loading project: c:\Users\Cole\Desktop\Projects\HyperText\AngleBracket.Test\AngleBracket.Test.csproj info: OmniSharp.MSBuild.ProjectManager Successfully loaded project file 'c:\Users\Cole\Desktop\Projects\HyperText\AngleBracket.Test\AngleBracket.Test.csproj'. info: OmniSharp.MSBuild.ProjectManager Adding project 'c:\Users\Cole\Desktop\Projects\HyperText\AngleBracket.Test\AngleBracket.Test.csproj' info: OmniSharp.MSBuild.ProjectManager Loading project: c:\Users\Cole\Desktop\Projects\HyperText\CodePoint\CodePoint.csproj info: OmniSharp.MSBuild.ProjectManager Successfully loaded project file 'c:\Users\Cole\Desktop\Projects\HyperText\CodePoint\CodePoint.csproj'. info: OmniSharp.MSBuild.ProjectManager Adding project 'c:\Users\Cole\Desktop\Projects\HyperText\CodePoint\CodePoint.csproj' info: OmniSharp.MSBuild.ProjectManager Loading project: c:\Users\Cole\Desktop\Projects\HyperText\CodePoint.Test\CodePoint.Test.csproj info: OmniSharp.MSBuild.ProjectManager Successfully loaded project file 'c:\Users\Cole\Desktop\Projects\HyperText\CodePoint.Test\CodePoint.Test.csproj'. info: OmniSharp.MSBuild.ProjectManager Adding project 'c:\Users\Cole\Desktop\Projects\HyperText\CodePoint.Test\CodePoint.Test.csproj' info: OmniSharp.MSBuild.ProjectManager Loading project: c:\Users\Cole\Desktop\Projects\HyperText\CurlyBracket\CurlyBracket.csproj info: OmniSharp.MSBuild.ProjectManager Successfully loaded project file 'c:\Users\Cole\Desktop\Projects\HyperText\CurlyBracket\CurlyBracket.csproj'. info: OmniSharp.MSBuild.ProjectManager Adding project 'c:\Users\Cole\Desktop\Projects\HyperText\CurlyBracket\CurlyBracket.csproj' info: OmniSharp.MSBuild.ProjectManager Loading project: c:\Users\Cole\Desktop\Projects\HyperText\CurlyBracket.Test\CurlyBracket.Test.csproj info: OmniSharp.MSBuild.ProjectManager Successfully loaded project file 'c:\Users\Cole\Desktop\Projects\HyperText\CurlyBracket.Test\CurlyBracket.Test.csproj'. info: OmniSharp.MSBuild.ProjectManager Adding project 'c:\Users\Cole\Desktop\Projects\HyperText\CurlyBracket.Test\CurlyBracket.Test.csproj' info: OmniSharp.MSBuild.ProjectManager Loading project: c:\Users\Cole\Desktop\Projects\HyperText\FiberWire\FiberWire.csproj info: OmniSharp.MSBuild.ProjectManager Successfully loaded project file 'c:\Users\Cole\Desktop\Projects\HyperText\FiberWire\FiberWire.csproj'. info: OmniSharp.MSBuild.ProjectManager Adding project 'c:\Users\Cole\Desktop\Projects\HyperText\FiberWire\FiberWire.csproj' info: OmniSharp.MSBuild.ProjectManager Loading project: c:\Users\Cole\Desktop\Projects\HyperText\FiberWire.Test\FiberWire.Test.csproj info: OmniSharp.MSBuild.ProjectManager Successfully loaded project file 'c:\Users\Cole\Desktop\Projects\HyperText\FiberWire.Test\FiberWire.Test.csproj'. info: OmniSharp.MSBuild.ProjectManager Adding project 'c:\Users\Cole\Desktop\Projects\HyperText\FiberWire.Test\FiberWire.Test.csproj' info: OmniSharp.MSBuild.ProjectManager Loading project: c:\Users\Cole\Desktop\Projects\HyperText\HyperText\HyperText.csproj info: OmniSharp.MSBuild.ProjectManager Successfully loaded project file 'c:\Users\Cole\Desktop\Projects\HyperText\HyperText\HyperText.csproj'. info: OmniSharp.MSBuild.ProjectManager Adding project 'c:\Users\Cole\Desktop\Projects\HyperText\HyperText\HyperText.csproj' info: OmniSharp.MSBuild.ProjectManager Loading project: c:\Users\Cole\Desktop\Projects\HyperText\StyleSheet\StyleSheet.csproj info: OmniSharp.MSBuild.ProjectManager Successfully loaded project file 'c:\Users\Cole\Desktop\Projects\HyperText\StyleSheet\StyleSheet.csproj'. info: OmniSharp.MSBuild.ProjectManager Adding project 'c:\Users\Cole\Desktop\Projects\HyperText\StyleSheet\StyleSheet.csproj' info: OmniSharp.MSBuild.ProjectManager Loading project: c:\Users\Cole\Desktop\Projects\HyperText\StyleSheet.Test\StyleSheet.Test.csproj info: OmniSharp.MSBuild.ProjectManager Successfully loaded project file 'c:\Users\Cole\Desktop\Projects\HyperText\StyleSheet.Test\StyleSheet.Test.csproj'. info: OmniSharp.MSBuild.ProjectManager Adding project 'c:\Users\Cole\Desktop\Projects\HyperText\StyleSheet.Test\StyleSheet.Test.csproj' info: OmniSharp.MSBuild.ProjectManager Loading project: c:\Users\Cole\Desktop\Projects\HyperText\Jint\Jint.csproj info: OmniSharp.MSBuild.ProjectManager Successfully loaded project file 'c:\Users\Cole\Desktop\Projects\HyperText\Jint\Jint.csproj'. info: OmniSharp.MSBuild.ProjectManager Adding project 'c:\Users\Cole\Desktop\Projects\HyperText\Jint\Jint.csproj' info: OmniSharp.MSBuild.ProjectManager Update project: AngleBracket info: OmniSharp.MSBuild.ProjectManager Update project: AngleBracket.Test info: OmniSharp.MSBuild.ProjectManager Update project: CodePoint info: OmniSharp.MSBuild.ProjectManager Update project: CodePoint.Test info: OmniSharp.MSBuild.ProjectManager Update project: CurlyBracket info: OmniSharp.MSBuild.ProjectManager Update project: CurlyBracket.Test info: OmniSharp.MSBuild.ProjectManager Update project: FiberWire info: OmniSharp.MSBuild.ProjectManager Update project: FiberWire.Test info: OmniSharp.MSBuild.ProjectManager Update project: HyperText info: OmniSharp.MSBuild.ProjectManager Update project: StyleSheet info: OmniSharp.MSBuild.ProjectManager Update project: StyleSheet.Test info: OmniSharp.MSBuild.ProjectManager Update project: Jint info: OmniSharp.Roslyn.CSharp.Services.Diagnostics.CSharpDiagnosticWorkerWithAnalyzers Solution initialized -> queue all documents for code analysis. Initial document count: 380. Received response for /quickinfo but could not find request. Received response for /quickinfo but could not find request. Received response for /v2/getcodeactions but could not find request.

C# log

Installing C# dependencies... Platform: win32, x86_64

Finished

Environment information

VSCode version: 1.64.2 C# Extension: 1.24.0

Dotnet Information .NET SDK (reflecting any global.json): Version: 6.0.200 Commit: 4c30de7899

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

Host (useful for support): Version: 6.0.2 Commit: 839cdfb0ec

.NET SDKs installed: 3.1.416 [C:\Program Files\dotnet\sdk] 5.0.405 [C:\Program Files\dotnet\sdk] 6.0.100-rc.1.21458.32 [C:\Program Files\dotnet\sdk] 6.0.100-rc.1.21463.6 [C:\Program Files\dotnet\sdk] 6.0.100-rc.2.21505.57 [C:\Program Files\dotnet\sdk] 6.0.101 [C:\Program Files\dotnet\sdk] 6.0.200 [C:\Program Files\dotnet\sdk]

.NET runtimes installed: Microsoft.AspNetCore.App 3.1.19 [C:\Program Files\dotnet\shared\Microsoft.AspNetCore.App] Microsoft.AspNetCore.App 3.1.22 [C:\Program Files\dotnet\shared\Microsoft.AspNetCore.App] Microsoft.AspNetCore.App 5.0.9 [C:\Program Files\dotnet\shared\Microsoft.AspNetCore.App] Microsoft.AspNetCore.App 5.0.10 [C:\Program Files\dotnet\shared\Microsoft.AspNetCore.App] Microsoft.AspNetCore.App 5.0.14 [C:\Program Files\dotnet\shared\Microsoft.AspNetCore.App] Microsoft.AspNetCore.App 6.0.0-rc.1.21452.15 [C:\Program Files\dotnet\shared\Microsoft.AspNetCore.App] Microsoft.AspNetCore.App 6.0.0-rc.2.21480.10 [C:\Program Files\dotnet\shared\Microsoft.AspNetCore.App] Microsoft.AspNetCore.App 6.0.2 [C:\Program Files\dotnet\shared\Microsoft.AspNetCore.App] Microsoft.NETCore.App 3.1.19 [C:\Program Files\dotnet\shared\Microsoft.NETCore.App] Microsoft.NETCore.App 3.1.22 [C:\Program Files\dotnet\shared\Microsoft.NETCore.App] Microsoft.NETCore.App 5.0.9 [C:\Program Files\dotnet\shared\Microsoft.NETCore.App] Microsoft.NETCore.App 5.0.10 [C:\Program Files\dotnet\shared\Microsoft.NETCore.App] Microsoft.NETCore.App 5.0.14 [C:\Program Files\dotnet\shared\Microsoft.NETCore.App] Microsoft.NETCore.App 6.0.0-rc.1.21451.13 [C:\Program Files\dotnet\shared\Microsoft.NETCore.App] Microsoft.NETCore.App 6.0.0-rc.2.21480.5 [C:\Program Files\dotnet\shared\Microsoft.NETCore.App] Microsoft.NETCore.App 6.0.2 [C:\Program Files\dotnet\shared\Microsoft.NETCore.App] Microsoft.WindowsDesktop.App 3.1.19 [C:\Program Files\dotnet\shared\Microsoft.WindowsDesktop.App] Microsoft.WindowsDesktop.App 3.1.22 [C:\Program Files\dotnet\shared\Microsoft.WindowsDesktop.App] Microsoft.WindowsDesktop.App 5.0.9 [C:\Program Files\dotnet\shared\Microsoft.WindowsDesktop.App] Microsoft.WindowsDesktop.App 5.0.10 [C:\Program Files\dotnet\shared\Microsoft.WindowsDesktop.App] Microsoft.WindowsDesktop.App 5.0.14 [C:\Program Files\dotnet\shared\Microsoft.WindowsDesktop.App] Microsoft.WindowsDesktop.App 6.0.0-rc.1.21451.3 [C:\Program Files\dotnet\shared\Microsoft.WindowsDesktop.App] Microsoft.WindowsDesktop.App 6.0.0-rc.2.21501.6 [C:\Program Files\dotnet\shared\Microsoft.WindowsDesktop.App] Microsoft.WindowsDesktop.App 6.0.2 [C:\Program Files\dotnet\shared\Microsoft.WindowsDesktop.App]

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

Visual Studio Code Extensions
Extension Author Version
base16-generator golf1052 1.15.0
better-cpp-syntax jeff-hykin 1.15.13
better-toml bungcip 0.3.2
code-spell-checker streetsidesoftware 2.1.7
copilot GitHub 1.7.5067
cpptools ms-vscode 1.9.0
cpptools-extension-pack ms-vscode 1.1.0
crates serayuzgur 0.5.10
csharp ms-dotnettools 1.24.0
gitlens eamodio 11.7.0
godot-tools geequlim 1.1.3
hexeditor ms-vscode 1.9.5
indent-rainbow oderwat 8.2.2
language-x86-64-assembly 13xforever 3.0.0
markdown-preview-enhanced shd101wyy 0.6.1
material-icon-theme PKief 4.13.0
midl-webidl-syntax dave-deletethis 0.0.1
mono-debug ms-vscode 0.16.2
npm-intellisense christian-kohler 1.4.1
nugetpackagemanagergui aliasadidev 1.1.9
platformio-ide platformio 2.4.2
python ms-python 2022.0.1814523869
remote-ssh ms-vscode-remote 0.74.0
remote-ssh-edit ms-vscode-remote 0.74.0
remote-wsl ms-vscode-remote 0.64.2
rust-analyzer matklad 0.2.940
sort-imports amatiasq 6.3.0
v4pvhdlforprofessionals ViDE-Software 1.1.2
vscode-eslint dbaeumer 2.2.2
vscode-firefox-debug firefox-devtools 2.9.6
vscode-nanoframework nanoframework 1.0.53
vscode-npm-script eg2 0.3.24
vscode-nuget-package-manager jmrog 1.1.6
vscode-pets tonybaloney 1.9.3
vscode-print pdconsec 0.9.14
vscode-pull-request-github GitHub 0.36.2
vscode-pylance ms-python 2022.2.3
vscode-tailwindcss bradlc 0.7.7
vscode-typescript-next ms-vscode 4.7.20220218
vscode-yaml redhat 1.4.0
vscodeintellicode VisualStudioExptTeam 1.2.17
vsliveshare ms-vsliveshare 1.0.5330
vsliveshare-audio ms-vsliveshare 0.1.91
wavetrace wavetrace 1.1.2

colejohnson66 avatar Feb 20 '22 01:02 colejohnson66

The C# extension also removes the coloring of the comment upon load. If I open VS Code with it disabled, I get syntax coloring of the XML, but once I enable it, the coloring goes away.

colejohnson66 avatar Feb 20 '22 01:02 colejohnson66

In my settings.json, my relevant settings are:

"csharp.semanticHighlighting.enabled": true,
"csharp.suppressHiddenDiagnostics": false,
"omnisharp.enableAsyncCompletion": true,
"omnisharp.enableDecompilationSupport": true,
"omnisharp.enableImportCompletion": true,
"omnisharp.enableRoslynAnalyzers": true,

Deleting them all has no effect.

colejohnson66 avatar Feb 21 '22 16:02 colejohnson66

The C# extension also removes the coloring of the comment upon load.

With semantic highlighting enabled the xml doc comments are classified differently and it is up to the theme how they are colored.. The Visual Studio 2019 Dark theme which is included with the C# extension colors these nicely.

JoeRobich avatar Feb 22 '22 23:02 JoeRobich

Disabling semantic highlighting does not fix the issue with coloring (even after restart). I am using the Dark+ theme. When cycling through them, I can see them colored for a split second before falling back to the color for comments. I'll try to get a video of it soon.

colejohnson66 avatar Feb 23 '22 13:02 colejohnson66

Also of note, the <c> tags are not typeset correctly in the popover.

colejohnson66 avatar Feb 23 '22 14:02 colejohnson66

I have a lot of trouble with the XML commenting in VS Code. I pretty much only use the summary tag because all the rest pretty much don't work for me. I wish they did, especially the <param> one.

scott-parkhill avatar May 16 '22 15:05 scott-parkhill

@scott-parkhill Apparently, their documentation overlay parser only cares about <summary> and nothing else. That file hasn't been touched in two years.

colejohnson66 avatar May 17 '22 13:05 colejohnson66

Thank you @colejohnson66, seems like a weekend project possibly there.

scott-parkhill avatar May 17 '22 18:05 scott-parkhill

@scott-parkhill Apparently, their documentation overlay parser only cares about <summary> and nothing else. That file hasn't been touched in two years.

@colejohnson66 I'm having trouble even seeing where the functions in that module are even being used.

johnborges avatar Oct 06 '22 13:10 johnborges