XML Comments

This is an extension to Visual Studio 2015 or 2019 that allows to create XML documentation comments. It works like entering three slashes (///) in C# but you can use it also in C++ and it updates existing comments.

The same extension for Visual Studio 2022 can be found at "XML Comments for Visual Studio 2022"

To insert XML comments just set the cursor to a function line and invoke the command Tools -Create/update XML comment.

This creates the comment block and you can fill the comment fields.

If the function signature changes later, you just call the command again and the comments gets updated without losing existing text:

Add missing comments and check if exising text needs to be updated.

If you invoke the comment for the first time the options dialog is shown where you can enter your user sign and define the comment block layout.

To change the options open Visual Studio options and go to the section XML Comments.

History

1.11.3

• Support Visual Studio 2019

1.11.2

• Minor enhancements to reading existing comments
• Better handling of value tags.

1.11

• Better parsing of type parameters
• Option to define the look of the comment separator line

1.10

• Support Visual Studio 2017

1.9

• Put options to Visual Studio options dialog

1.8

• Better parsing of other comment styles
• Keep comment for renamed parameter, if on same position
• Don't write return element for void functions

1.7

• Better parsing of function parameters that include templates.
• Better parsing of existing comments with non-XML format