XML Documentation Comments Support for Visual Studio Code

Generate XML documentation comments for Visual Studio Code.

Usage

Type "///", it auto-generates an XML doucumentation comment like this:

Configuration

The menu under File > Preferences (Code > Preferences on Mac) provides entries to configure user and workspace settings. You are provided with a list of Default Settings. Copy any setting that you want to change to the related settings.json file.

settings.json

{
	// Press the Enter key to activate a command (Default: false)
	"docomment.activateOnEnter": true,
	// Insert spaces when pressing Tab.
	"editor.insertSpaces": true,
	// The number of spaces a tab is equal to.
	"editor.tabSize": 4
}

Installation

1. Install Visual Studio Code 1.8.0 or higher
2. Launch Code
3. From the extension view Ctrl-Shift-X (Windows, Linux) or Cmd-Shift-X (macOS)
4. Search and Choose the extension C# XML Documentation Comments
5. Reload Visual Studio Code

Supported Languages

• C#

Contributing to the Code

Clone a copy of the repo:

git clone https://github.com/k--kato/vscode-docomment.git

Building the code

First, install the package dependencies:

npm install

Now you can compile the code:

npm run compile

After the initial compile, the source files will be watched and recompiled when changes are saved.

Contributors

• @ivanz
• @PJB3005

License

This extension is licensed under the MIT License.