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

XmlDoc snippet is not automatically generated by typing triple forward slashes anymore

Open DanteMarshal opened this issue 1 year ago • 1 comments

Steps to reproduce

  1. Make sure the extension is enabled and fully loaded
  2. Open a .cs file with a member, a method or a class that lacks documentation
  3. Type /// over it

Expected behavior

An XmlDoc snippet should be generated, including the summary tag and also param and exception tag for methods if any.

Actual behavior

Nothing is generated, only the /// I typed.

Additional context

This feature used to work in earlier versions but I don's exactly know which update broke it.

Environment data

dotnet --info output:

.NET SDK:
 Version:           8.0.101
 Commit:            6eceda187b
 Workload version:  8.0.100-manifests.8a1da915

Runtime Environment:
 OS Name:     Windows
 OS Version:  10.0.22621
 OS Platform: Windows
 RID:         win-x64
 Base Path:   C:\Program Files\dotnet\sdk\8.0.101\

.NET workloads installed:
 Workload version: 8.0.100-manifests.8a1da915
 [maui-windows]
   Installation Source: VS 17.8.34408.163
   Manifest Version:    8.0.3/8.0.100
   Manifest Path:       C:\Program Files\dotnet\sdk-manifests\8.0.100\microsoft.net.sdk.maui\8.0.3\WorkloadManifest.json
   Install Type:              Msi


Host:
  Version:      8.0.1
  Architecture: x64
  Commit:       bf5e279d92

.NET SDKs installed:
  8.0.101 [C:\Program Files\dotnet\sdk]

.NET runtimes installed:
  Microsoft.AspNetCore.App 6.0.26 [C:\Program Files\dotnet\shared\Microsoft.AspNetCore.App]
  Microsoft.AspNetCore.App 7.0.15 [C:\Program Files\dotnet\shared\Microsoft.AspNetCore.App]
  Microsoft.AspNetCore.App 8.0.1 [C:\Program Files\dotnet\shared\Microsoft.AspNetCore.App]
  Microsoft.NETCore.App 6.0.26 [C:\Program Files\dotnet\shared\Microsoft.NETCore.App]
  Microsoft.NETCore.App 7.0.15 [C:\Program Files\dotnet\shared\Microsoft.NETCore.App]
  Microsoft.NETCore.App 8.0.1 [C:\Program Files\dotnet\shared\Microsoft.NETCore.App]
  Microsoft.WindowsDesktop.App 6.0.26 [C:\Program Files\dotnet\shared\Microsoft.WindowsDesktop.App]
  Microsoft.WindowsDesktop.App 7.0.15 [C:\Program Files\dotnet\shared\Microsoft.WindowsDesktop.App]
  Microsoft.WindowsDesktop.App 8.0.1 [C:\Program Files\dotnet\shared\Microsoft.WindowsDesktop.App]

Other architectures found:
  x86   [C:\Program Files (x86)\dotnet]
    registered at [HKLM\SOFTWARE\dotnet\Setup\InstalledVersions\x86\InstallLocation]

Environment variables:
  Not set

global.json file:
  Not found

Learn more:
  https://aka.ms/dotnet/info

Download .NET:
  https://aka.ms/dotnet/download

VS Code version:

Version: 1.85.1
Commit: 0ee08df0cf4527e40edc9aa28f4b5bd38bbff2b2
Date: 2023-12-13T09:49:37.021Z
Electron: 25.9.7
ElectronBuildId: 25551756
Chromium: 114.0.5735.289
Node.js: 18.15.0
V8: 11.4.183.29-electron.0
OS: Windows_NT x64 10.0.22621

C# Extension version

v2.15.30

DanteMarshal avatar Jan 18 '24 17:01 DanteMarshal

Possibly related to #7184 ??

taftster avatar Jun 06 '24 16:06 taftster

I forgot to reply to this issue so I may be wrong since it was a long time ago, but I think this was a problem because I was using Omnisharp (Setting dotnet.server.useOmnisharp was enabled) at the time.

If you're using omnisharp, you need another extension (k--kato.docomment) enabled to put the docs for you.

If you're not using omnisharp, having that extension will generate double xml-doc comments when you type /// so if you're not using omnisharp, you gotta disable it and let the C# extension handle xml-doc comments for you.

DanteMarshal avatar Oct 25 '24 08:10 DanteMarshal