XML Auto Commenting C# in Visual Studio Code

Question

In MonoDevelop, when I type "///", it auto-generates an xml-style comment like this:

/// <summary>
/// Describes the variable x
/// </summary>
int x = 0;

Is there a way to get this behavior in Visual Studio Code?

By default, looks like that doesn't work for local variables. /// works for method signatures and class properties though. Do you really comment local variables? — Andy Wiesendanger
– Andy Wiesendanger, Commented Dec 14, 2015 at 19:43
There is no a practical use for this, you can do this in Visual studio with all properties and methods, if it is a local varialbe then just a comment (//) should be enough — bto.rdz
– bto.rdz, Commented Dec 14, 2015 at 19:54
That's weird. For me, it doesn't work for methods or properties. Is there maybe a setting I need to change? — s2Jakob
– s2Jakob, Commented Dec 14, 2015 at 19:54
To be clear: I am using Visual Studio Code(code.visualstudio.com), not the regular visual studio. — s2Jakob
– s2Jakob, Commented Dec 14, 2015 at 19:57

KyleMit · Accepted Answer · 2022-06-29 15:58:43Z

92

Starting with C# for Visual Studio Code Extension 1.23.8 this is supported when Editor: Format On Type. setting is enabled.

Settings can be found in the menu under File/Preferences/Settings (Windows/Linux) / Code/Preferences/Settings (macOS).

The required setting is available under Text Editor/Formatting.

{
    "editor.formatOnType": true,
}

edited Jun 29, 2022 at 15:58

KyleMit♦

31.4k74 gold badges519 silver badges715 bronze badges

answered Jan 14, 2021 at 9:18

Pascal Berger

4,4123 gold badges35 silver badges55 bronze badges

Sign up to request clarification or add additional context in comments.

3 Comments

3Dave Over a year ago

Thanks for the update - this saved me a bit of time.

alexpanter Over a year ago

I was looking for this setting under C#. Thank you.

cap29 Over a year ago

In Mac it is under Code/Preferences/Settings/Text Editor/Formatting

Aejay · Accepted Answer · 2017-10-10 17:35:43Z

55

This feature is not available out-of-the-box with VS Code, but like most features is available via third-party extensions. As of the time of this answer, here is a popular extension that provides some XML comments support to VS Code:

C# XML Documentation Comments Support for Visual Studio Code

If that extension doesn't work for you, you may be able to find alternatives by searching the VS Code Marketplace

edited Oct 10, 2017 at 17:35

Aejay

9299 silver badges19 bronze badges

answered Jan 6, 2016 at 14:57

Keisuke KATO

1,5291 gold badge16 silver badges26 bronze badges

1 Comment

Elijah M Over a year ago

That extension is deprecated as it is built in to the C# for Visual Studio Code extension (see Pascal's answer)

JayChase · Accepted Answer · 2023-01-18 01:29:46Z

5

You can set this just for c# if you use Visual Studio Code for other languages as well:

Open the command palette and search for Configure Language Specific Settings

Select C# and search for Format On Type

Docs

answered Jan 18, 2023 at 1:29

JayChase

11.7k3 gold badges53 silver badges55 bronze badges

4 Comments

Luuk Over a year ago

Sorry this did not work, even after a complete un-install of VSCode, and Completely uninstall VS Code extensions (code --list-extensions: ms-dotnettools.csdevkit; ms-dotnettools.csharp; ms-dotnettools.vscode-dotnet-runtime; ms-vscode-remote.remote-wsl / code --version: 1.90.0)

kanagaraj palanisamy Over a year ago

it was working until last week and stopped working now. I tried all the methods mentioned in this thread.

Aaron Over a year ago

Agreed. Something broke within the past couple days.

SuperDre Over a year ago

still not working with 1.95.3 (Windows)

Collectives™ on Stack Overflow

XML Auto Commenting C# in Visual Studio Code

3 Answers 3

3 Comments

1 Comment

4 Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

3 Answers 3

3 Comments

1 Comment

4 Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related