Generated XML documentation for C# not working as expected
See original GitHub issueIssue Description
I have been following this PR here that is supposed to add suport for C# XML comment generation using ///
if the setting editor.formatOnType
is set to true
.
https://github.com/OmniSharp/omnisharp-vscode/pull/4261
I’ve done this and it appears to not do anything. I’ve checked for updates on both the C# extension and vscode. See video below for what’s happening:
https://drive.google.com/file/d/1j3jZgbR3R0ByN4eHWod35_5JvHL_KTM_/view?usp=sharing
Steps to Reproduce
Install C# extension, set editor.formatOnType: true
, try to add xml comments to a class using ///
.
Expected Behavior
The XML comments are generated
Actual Behavior
Nothing happens when you type ///
Logs
OmniSharp log
C# log
Environment information
VSCode version: 1.52.1 C# Extension: 1.23.9
Mono Information
OmniSharp using built-in monoDotnet Information
.NET Core SDK (reflecting any global.json): Version: 3.1.402 Commit: 9b5de826fdRuntime Environment: OS Name: Mac OS X OS Version: 10.16 OS Platform: Darwin RID: osx.10.16-x64 Base Path: /usr/local/share/dotnet/sdk/3.1.402/
Host (useful for support): Version: 3.1.8 Commit: 9c1330dedd
.NET Core SDKs installed: 2.2.207 [/usr/local/share/dotnet/sdk] 3.1.300 [/usr/local/share/dotnet/sdk] 3.1.402 [/usr/local/share/dotnet/sdk]
.NET Core runtimes installed: Microsoft.AspNetCore.All 2.2.8 [/usr/local/share/dotnet/shared/Microsoft.AspNetCore.All] Microsoft.AspNetCore.App 2.2.8 [/usr/local/share/dotnet/shared/Microsoft.AspNetCore.App] Microsoft.AspNetCore.App 3.1.3 [/usr/local/share/dotnet/shared/Microsoft.AspNetCore.App] Microsoft.AspNetCore.App 3.1.4 [/usr/local/share/dotnet/shared/Microsoft.AspNetCore.App] Microsoft.AspNetCore.App 3.1.8 [/usr/local/share/dotnet/shared/Microsoft.AspNetCore.App] Microsoft.NETCore.App 2.2.8 [/usr/local/share/dotnet/shared/Microsoft.NETCore.App] Microsoft.NETCore.App 3.1.8 [/usr/local/share/dotnet/shared/Microsoft.NETCore.App]
To install additional .NET Core runtimes or SDKs: https://aka.ms/dotnet-download
Visual Studio Code Extensions
Extension | Author | Version |
---|---|---|
addDocComments | stevencl | 0.0.8 |
code-spell-checker | streetsidesoftware | 1.10.2 |
csharp | ms-dotnettools | 1.23.9 |
go | golang | 0.22.0 |
mdx | silvenon | 0.1.0 |
postcss | csstools | 1.0.9 |
prettier-vscode | esbenp | 5.8.0 |
quicktype | quicktype | 12.0.46 |
remote-containers | ms-vscode-remote | 0.155.1 |
spellright | ban | 3.0.56 |
vscode-docker | ms-azuretools | 1.9.1 |
vscode-eslint | dbaeumer | 2.1.14 |
vscode-jest-runner | firsttris | 0.4.31 |
vscode-react-native | msjsdiag | 1.3.0 |
vscode-sort-json | richie5um2 | 1.19.2 |
vscode-tailwindcss | bradlc | 0.5.8 |
Issue Analytics
- State:
- Created 3 years ago
- Comments:10 (3 by maintainers)
Top GitHub Comments
can you set
"omnisharp.loggingLevel": "debug"
and post the OmniSharp log when this problem occurs? It definitely should be working.Okay thanks for that I will investigate that!