Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

<param> Doc Comments Aren't in Tooltip

See original GitHub issue

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)

    Checking the 'DOTNET_ROOT' environment variable to find a .NET SDK

    Using the 'dotnet' on the PATH.

    DotNetPath set to dotnet

    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"

    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"

    Invoking Workspace Options Provider: OmniSharp.Roslyn.CSharp.Services.CSharpFormattingWorkspaceOptionsProvider, Order: 0

    Invoking Workspace Options Provider: OmniSharp.Roslyn.CSharp.Services.Completion.CompletionOptionsProvider, Order: 0

    Invoking Workspace Options Provider: OmniSharp.Roslyn.CSharp.Services.RenameWorkspaceOptionsProvider, Order: 100

    Invoking Workspace Options Provider: OmniSharp.Roslyn.CSharp.Services.ImplementTypeWorkspaceOptionsProvider, Order: 110

    Invoking Workspace Options Provider: OmniSharp.Roslyn.CSharp.Services.BlockStructureWorkspaceOptionsProvider, Order: 140

    Detecting Cake files in 'c:\Users\Cole\Desktop\Projects\HyperText'.

    Did not find any Cake files

    Detecting projects in 'c:\Users\Cole\Desktop\Projects\HyperText\HyperText.sln'.

    Queue project update for 'c:\Users\Cole\Desktop\Projects\HyperText\AngleBracket\AngleBracket.csproj'

    Queue project update for 'c:\Users\Cole\Desktop\Projects\HyperText\AngleBracket.Test\AngleBracket.Test.csproj'

    Queue project update for 'c:\Users\Cole\Desktop\Projects\HyperText\CodePoint\CodePoint.csproj'

    Queue project update for 'c:\Users\Cole\Desktop\Projects\HyperText\CodePoint.Test\CodePoint.Test.csproj'

    Queue project update for 'c:\Users\Cole\Desktop\Projects\HyperText\CurlyBracket\CurlyBracket.csproj'

    Queue project update for 'c:\Users\Cole\Desktop\Projects\HyperText\CurlyBracket.Test\CurlyBracket.Test.csproj'

    Queue project update for 'c:\Users\Cole\Desktop\Projects\HyperText\FiberWire\FiberWire.csproj'

    Queue project update for 'c:\Users\Cole\Desktop\Projects\HyperText\FiberWire.Test\FiberWire.Test.csproj'

    Queue project update for 'c:\Users\Cole\Desktop\Projects\HyperText\HyperText\HyperText.csproj'

    Queue project update for 'c:\Users\Cole\Desktop\Projects\HyperText\StyleSheet\StyleSheet.csproj'

    Queue project update for 'c:\Users\Cole\Desktop\Projects\HyperText\StyleSheet.Test\StyleSheet.Test.csproj'

    Queue project update for 'c:\Users\Cole\Desktop\Projects\HyperText\Jint\Jint.csproj'

    Detecting CSX files in 'c:\Users\Cole\Desktop\Projects\HyperText'.

    Loading project: c:\Users\Cole\Desktop\Projects\HyperText\AngleBracket\AngleBracket.csproj

    Did not find any CSX files

    Configuration finished.

    Omnisharp server running using Stdio at location 'c:\Users\Cole\Desktop\Projects\HyperText' on host 17160.

    Successfully loaded project file 'c:\Users\Cole\Desktop\Projects\HyperText\AngleBracket\AngleBracket.csproj'.

    Adding project 'c:\Users\Cole\Desktop\Projects\HyperText\AngleBracket\AngleBracket.csproj'

    Loading project: c:\Users\Cole\Desktop\Projects\HyperText\AngleBracket.Test\AngleBracket.Test.csproj

    Successfully loaded project file 'c:\Users\Cole\Desktop\Projects\HyperText\AngleBracket.Test\AngleBracket.Test.csproj'.

    Adding project 'c:\Users\Cole\Desktop\Projects\HyperText\AngleBracket.Test\AngleBracket.Test.csproj'

    Loading project: c:\Users\Cole\Desktop\Projects\HyperText\CodePoint\CodePoint.csproj

    Successfully loaded project file 'c:\Users\Cole\Desktop\Projects\HyperText\CodePoint\CodePoint.csproj'.

    Adding project 'c:\Users\Cole\Desktop\Projects\HyperText\CodePoint\CodePoint.csproj'

    Loading project: c:\Users\Cole\Desktop\Projects\HyperText\CodePoint.Test\CodePoint.Test.csproj

    Successfully loaded project file 'c:\Users\Cole\Desktop\Projects\HyperText\CodePoint.Test\CodePoint.Test.csproj'.

    Adding project 'c:\Users\Cole\Desktop\Projects\HyperText\CodePoint.Test\CodePoint.Test.csproj'

    Loading project: c:\Users\Cole\Desktop\Projects\HyperText\CurlyBracket\CurlyBracket.csproj

    Successfully loaded project file 'c:\Users\Cole\Desktop\Projects\HyperText\CurlyBracket\CurlyBracket.csproj'.

    Adding project 'c:\Users\Cole\Desktop\Projects\HyperText\CurlyBracket\CurlyBracket.csproj'

    Loading project: c:\Users\Cole\Desktop\Projects\HyperText\CurlyBracket.Test\CurlyBracket.Test.csproj

    Successfully loaded project file 'c:\Users\Cole\Desktop\Projects\HyperText\CurlyBracket.Test\CurlyBracket.Test.csproj'.

    Adding project 'c:\Users\Cole\Desktop\Projects\HyperText\CurlyBracket.Test\CurlyBracket.Test.csproj'

    Loading project: c:\Users\Cole\Desktop\Projects\HyperText\FiberWire\FiberWire.csproj

    Successfully loaded project file 'c:\Users\Cole\Desktop\Projects\HyperText\FiberWire\FiberWire.csproj'.

    Adding project 'c:\Users\Cole\Desktop\Projects\HyperText\FiberWire\FiberWire.csproj'

    Loading project: c:\Users\Cole\Desktop\Projects\HyperText\FiberWire.Test\FiberWire.Test.csproj

    Successfully loaded project file 'c:\Users\Cole\Desktop\Projects\HyperText\FiberWire.Test\FiberWire.Test.csproj'.

    Adding project 'c:\Users\Cole\Desktop\Projects\HyperText\FiberWire.Test\FiberWire.Test.csproj'

    Loading project: c:\Users\Cole\Desktop\Projects\HyperText\HyperText\HyperText.csproj

    Successfully loaded project file 'c:\Users\Cole\Desktop\Projects\HyperText\HyperText\HyperText.csproj'.

    Adding project 'c:\Users\Cole\Desktop\Projects\HyperText\HyperText\HyperText.csproj'

    Loading project: c:\Users\Cole\Desktop\Projects\HyperText\StyleSheet\StyleSheet.csproj

    Successfully loaded project file 'c:\Users\Cole\Desktop\Projects\HyperText\StyleSheet\StyleSheet.csproj'.

    Adding project 'c:\Users\Cole\Desktop\Projects\HyperText\StyleSheet\StyleSheet.csproj'

    Loading project: c:\Users\Cole\Desktop\Projects\HyperText\StyleSheet.Test\StyleSheet.Test.csproj

    Successfully loaded project file 'c:\Users\Cole\Desktop\Projects\HyperText\StyleSheet.Test\StyleSheet.Test.csproj'.

    Adding project 'c:\Users\Cole\Desktop\Projects\HyperText\StyleSheet.Test\StyleSheet.Test.csproj'

    Loading project: c:\Users\Cole\Desktop\Projects\HyperText\Jint\Jint.csproj

    Successfully loaded project file 'c:\Users\Cole\Desktop\Projects\HyperText\Jint\Jint.csproj'.

    Adding project 'c:\Users\Cole\Desktop\Projects\HyperText\Jint\Jint.csproj'

    Update project: AngleBracket

    Update project: AngleBracket.Test

    Update project: CodePoint

    Update project: CodePoint.Test

    Update project: CurlyBracket

    Update project: CurlyBracket.Test

    Update project: FiberWire

    Update project: FiberWire.Test

    Update project: HyperText

    Update project: StyleSheet

    Update project: StyleSheet.Test

    Update project: Jint

    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

Issue Analytics

State:
Created 2 years ago
Reactions:2
Comments:9 (1 by maintainers)

Top GitHub Comments

2reactions

colejohnson66commented, May 17, 2022

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

2reactions

scott-parkhillcommented, May 16, 2022

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.

Top Results From Across the Web

Parameter tooltip shows enclosing function's entire doxygen ...

Steps to reproduce: Define a C/C++ function with parameters and a doxygen comment that documents each parameter. Add some code to the function ......

Visual Studio 2013 Documentation comments not working ...

I'm using Visual Studio 2013 Community Edition, and it seems like documentation comments aren't always getting recognized. I tried to use the format...

IntelliJ show JavaDocs tooltip on mouse over - Stack Overflow

In Editor > General > Other (section) > Show quick documentation on mouse ... Select this check box to show quick documentation for...

JS Docs: A Quickstart Guide. JSDocs is a way for us ... - Medium

JSDocs is a way for us to document and add information to the code we've written. This information appears in a tooltip and...

Effective Dart: Documentation

Doc comments aren't just for external consumers of your library's public API. ... class RadioButtonWidget extends Widget { /// Sets the tooltip for...