question-mark
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.

Generated XML documentation for C# not working as expected

See original GitHub issue

Issue 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

Post the output from Output-->OmniSharp log here

C# log

Post the output from Output-->C# here

Environment information

VSCode version: 1.52.1 C# Extension: 1.23.9

Mono Information OmniSharp using built-in mono
Dotnet Information .NET Core SDK (reflecting any global.json): Version: 3.1.402 Commit: 9b5de826fd

Runtime 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:closed
  • Created 3 years ago
  • Comments:10 (3 by maintainers)

github_iconTop GitHub Comments

1reaction
filipwcommented, Feb 4, 2021

can you set "omnisharp.loggingLevel": "debug" and post the OmniSharp log when this problem occurs? It definitely should be working.

0reactions
sethreidnzcommented, Feb 4, 2021

@sethreidnz As @333fred said, we do not ship localizations with our packaged build tools to keep the download size small. However, the Assembly loader will still try to resolve them and report these warnings.

I found this MSBuild issue where they fixed a breaking change with the SdkResultFactory.IndicateSuccess method (dotnet/msbuild#5534). Try upgrading to the latest dotnet core 3.1405 sdk (https://dotnet.microsoft.com/download/dotnet-core/thank-you/sdk-3.1.405-macos-x64-installer) and see if you still get this error.

Okay thanks for that I will investigate that!

Read more comments on GitHub >

github_iconTop Results From Across the Web

Visual Studio 2022 Intellisense XML documentation started ...
Today however it all stopped showing up, so I tried following some recommendations from past posts, turning on or off the generation of...
Read more >
XML documentation comments not working as intended - Reddit
I'm learning to add XML comments to describe my functions in visual studio 2022.According to the book im reading if I type ///...
Read more >
Insert XML documentation comments - Visual Studio (Windows)
Learn how to insert XML documentation comments in your code that you can use to create a compiler-generated XML file to distribute alongside ......
Read more >
Using <code> and <example> Tags in C# XML ... - Pluralsight
The .NET compiler has an option that reads the XML documentation comments and generates XML documentation from them. This XML documentation can ...
Read more >
XML Documentation for refrenced projects fails to copy for live ...
Part of that test is verifing that the the XML documentation generated by visual ... FileNotFoundException: Could not find file 'C:\Repos\VetLogic API\HS.
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found