XML Auto Commenting C# in Visual Studio Code

c# xml-comments visual-studio-code
s2Jakob picture s2Jakob · Dec 14, 2015 · Viewed 20.2k times · Source

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?

Answer

Keisuke KATO picture Keisuke KATO · Jan 6, 2016

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

Related questions

How to have comments in IntelliSense for function in Visual Studio?

In Visual Studio and C#, when using a built in function such as ToString(), IntelliSense shows a yellow box explaining what it does. How can I have that for functions and properties I write?

Read More
C# XML /// Comments, where does <returns></returns> tag show up?

I am currently a programming student, and obviously my question is simple, but I haven't been able to find the answer to it online. So here it is: In XML /// comments in C#, where does the <returns> tag …

Read More
Using C#'s XML comment cref attribute with params syntax

In C#, I am trying to use <see cref="blah"/> to reference a method signature that contains the params keyword. I know this converts the parameter list to an array, but I can't even figure out how to …

Read More