C# XML Documentation Comments installs statistics

XML Documentation Comments Support for Visual Studio Code

Generate XML documentation comments for Visual Studio Code.

Deprecated Announcement

C# for Visual Studio Code (powered by OmniSharp) now officially supports the documentation comment from v1.23.8 (December 18th, 2020). You can use the official one by turning on Editor: Format On Type.

This extension will be deprecated in the future. Thanks to the users who have supported me so far. 2023/3/11 No features will be added, but only maintenance of the library will continue at the user's request.

Usage

Type "///", it auto-generates an XML documentation 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

To enable publishing XML documentation:

project.csproj

When DocumentationFile compiler option was specified, but one or more constructs did not have comments, it will produce CS1591 warning. You can optionally add a $(NoWarn);1591 property to avoid these warnings.

Installation

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

Supported Languages

• C# • Blazor

Contributing to the Code

Clone a copy of the repo:

Building the code

First, install the package dependencies:

Now you can compile the code:

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

Contributors

• @kasecato • @ivanz • @PJB3005 • @Acid147 • @doggy8088

License

This extension is licensed under the MIT License.