333fred
commented
3 years ago Alright, I took a look at this. Unfortunately, this seems like a roslyn bug: the QuickInfoProvider is giving us a TaggedText section with a Tag of Text, which we dutifully render as plaintext. There does exist a Style property that indicates the tag should be rendered as Code, not as plaintext, but that style is currently internal so we can't easily access it. @sharwell, is that property something you'd be in favor of making public? If so, I can open an API proposal for it.
sharwell
Issue Description
Some documentation comment tags, namely
codeandcdo not render rich text and simply display their text contents verbatim as if without the tag.Steps to Reproduce
Here's an example interface method with all of these:
/// Begins a transaction on a realm. If a transaction is already in progress for the given realm instance, ///null is returned, since multiple transactions on a given instance are invalid. This can be used
/// to begin a transaction if not already in one.
///
///
///
////// using (var transaction = realmService.BeginTransaction()) /// { /// // do some stuff that needs a write transaction /// /// // now commit this transaction, or leave the outer transaction to do the committing /// transaction?.Commit(); /// } //////Done as documented
Expected Behavior
codeblock should be rendered as a code block, andcas inline code.TypeScript docs do this:
Actual Behavior
I get a comment with some tags rendering, but not the aforementioned two.
Logs
OmniSharp log
C# log
This is empty.
Environment information
VSCode version: 1.58.0 C# Extension: 1.23.12
Dotnet Information
.NET SDK (reflecting any global.json): Version: 5.0.300 Commit: 2e0c8c940e Runtime Environment: OS Name: Windows OS Version: 10.0.19042 OS Platform: Windows RID: win10-x64 Base Path: C:\Program Files\dotnet\sdk\5.0.300\ Host (useful for support): Version: 5.0.6 Commit: 478b2f8c0e .NET SDKs installed: 2.1.801 [C:\Program Files\dotnet\sdk] 2.1.802 [C:\Program Files\dotnet\sdk] 2.2.401 [C:\Program Files\dotnet\sdk] 5.0.300 [C:\Program Files\dotnet\sdk] .NET runtimes installed: Microsoft.AspNetCore.All 2.1.12 [C:\Program Files\dotnet\shared\Microsoft.AspNetCore.All] Microsoft.AspNetCore.All 2.1.13 [C:\Program Files\dotnet\shared\Microsoft.AspNetCore.All] Microsoft.AspNetCore.All 2.1.28 [C:\Program Files\dotnet\shared\Microsoft.AspNetCore.All] Microsoft.AspNetCore.All 2.2.6 [C:\Program Files\dotnet\shared\Microsoft.AspNetCore.All] Microsoft.AspNetCore.App 2.1.12 [C:\Program Files\dotnet\shared\Microsoft.AspNetCore.App] Microsoft.AspNetCore.App 2.1.13 [C:\Program Files\dotnet\shared\Microsoft.AspNetCore.App] Microsoft.AspNetCore.App 2.1.28 [C:\Program Files\dotnet\shared\Microsoft.AspNetCore.App] Microsoft.AspNetCore.App 2.2.6 [C:\Program Files\dotnet\shared\Microsoft.AspNetCore.App] Microsoft.AspNetCore.App 3.1.15 [C:\Program Files\dotnet\shared\Microsoft.AspNetCore.App] Microsoft.AspNetCore.App 5.0.6 [C:\Program Files\dotnet\shared\Microsoft.AspNetCore.App] Microsoft.NETCore.App 2.1.12 [C:\Program Files\dotnet\shared\Microsoft.NETCore.App] Microsoft.NETCore.App 2.1.13 [C:\Program Files\dotnet\shared\Microsoft.NETCore.App] Microsoft.NETCore.App 2.1.28 [C:\Program Files\dotnet\shared\Microsoft.NETCore.App] Microsoft.NETCore.App 2.2.6 [C:\Program Files\dotnet\shared\Microsoft.NETCore.App] Microsoft.NETCore.App 3.1.12 [C:\Program Files\dotnet\shared\Microsoft.NETCore.App] Microsoft.NETCore.App 3.1.15 [C:\Program Files\dotnet\shared\Microsoft.NETCore.App] Microsoft.NETCore.App 5.0.6 [C:\Program Files\dotnet\shared\Microsoft.NETCore.App] Microsoft.WindowsDesktop.App 3.1.15 [C:\Program Files\dotnet\shared\Microsoft.WindowsDesktop.App] Microsoft.WindowsDesktop.App 5.0.6 [C:\Program Files\dotnet\shared\Microsoft.WindowsDesktop.App] To install additional .NET runtimes or SDKs: https://aka.ms/dotnet-downloadVisual Studio Code Extensions
|Extension|Author|Version| |---|---|---| |alphabetical-sorter|ue|2.0.1| |auto-using|Fudge|0.7.15| |bbcode|rickvansloten|0.0.2| |change-case|wmaurer|1.0.0| |cpptools|ms-vscode|1.5.1| |csharp|ms-dotnettools|1.23.12| |csharpfixformat|Leopotam|0.0.84| |debugger-for-chrome|msjsdiag|4.12.12| |EditorConfig|EditorConfig|0.16.4| |file-icons|file-icons|1.0.29| |gitlens|eamodio|11.5.1| |ilspy-vscode|icsharpcode|0.11.2| |markdown-all-in-one|yzhang|3.4.0| |msbuild-project-tools|tintoy|0.3.15| |msbuild-tools|sterin|0.0.12| |nord-visual-studio-code|arcticicestudio|0.17.1| |prettier-vscode|esbenp|8.0.1| |pug|amandeepmittal|1.0.1| |python|ms-python|2021.6.944021595| |remote-wsl|ms-vscode-remote|0.58.2| |santacodes-region-viewer|SantaCodes|1.0.0| |sass-lint|glen-84|1.0.7| |sln-support|logerfo|0.0.1| |spellright|ban|3.0.58| |uuid-generator|netcorext|0.0.4| |vdf|GEEKiDoS|0.0.7| |vscode-commons|redhat|0.0.6| |vscode-csproj|lucasazzola|0.7.0| |vscode-docker|ms-azuretools|1.14.0| |vscode-dotnet-runtime|ms-dotnettools|1.1.0| |vscode-eslint|dbaeumer|2.1.23| |vscode-gitignore-generator|piotrpalarz|1.0.3| |vscode-nuget-package-manager|jmrog|1.1.6| |vscode-pylance|ms-python|2021.7.2| |vscode-solution-explorer|fernandoescolar|0.4.3| |vscode-xml|redhat|0.17.0| |vsliveshare|ms-vsliveshare|1.0.4531| |webgl-glsl-editor|raczzalan|1.2.1| |xml|DotJoshJohnson|2.5.1| |yarn-task-provider|dkneeland|0.2.2|;Edit: formatting, typo