Commenting Source Code

VSdocman can generate documentation even without any additional comments in the source code. All Methods, Properties, Events and other links are generated properly and parameters descriptions and other sections are also included.

However, it is good to include additional descriptions directly into the source code. It is done by adding standard XML comments which VSdocman understands in both C# and VB .NET.

Commenting is based on tags that are included in your comments.

For example

/// <summary>This is my method.</summary>
/// <remarks>This is a remarks section</remarks>
void MyMethod()

Automatic Addition of Comment

User can write all that comment manually but he is not required to do so. VSdocman can do that automatically. VSdocman has an intelligent mechanism for inserting comments. Depending on code element name or type, you can easily insert predefined default comment. For example, the "Gets or sets a value indicating whether ..." summary text is automatically generated for boolean properties. This is controlled by comment templates which are fully customizable by user. There are some predefined templates for the most common cases.

When user clicks right mouse button on the code window, the pop-up menu appears. Menu contains Add XML Comment, Comment Editor and Add Description Attribute items which perform the following actions:

  1. Add XML Comment automatically adds the default XML comment to the current member. User can preset how the default comment should look like.

    Adding default customizable XML comment
  2. Comment Editor invokes the WYSIWYG Comment editor for selected member. This is useful when creating complicated documentation including cross-references, pictures, tables and others. Comment editor provides a user-friendly graphical way for editing the comments.

    WYSIWYG comment editor
  3. Add Description Attribute automatically adds the Description attribute to the current member. Short property description in Properties Window must be defined with System.ComponentModel.Description attribute.

    Description attribute


Start generating your .NET documentation now!
Free, fully functional trial
VSdocman Tip
You can generate documentation in your automated builds. VSdocman supports command line mode.

Medical institutions
Government institutions
Large financial institutions
Thousands of SW companies

Deloitte & Touche
Wells Fargo


Rolls-Royce Naval Marine
Toyota Motorsport

Mitsubishi Electric
Johnson Controls
Bentley Systems

Hewlett Packard
Bosch (Australia)
Schneider Electric

Volvo Information Technology
Agilent Technologies
Tesco SW

Fraunhofer Heinrich-Hertz-Institut

A few years ago, we gave a test to several products to document our source code. We finally chose VSdocman mostly because it was easy to use, from within the development environment, making training of programmers useless. It provides flexible features which enables producing complete documentation for people using our products and also for internal use. When technical support is required (we needed this when switching to VS 2015), Peter answered our emails very quickly. After more than 3 years with VSdocman, we strongly recommend the product which is amazingly easier to use than SandCastle.

Pierrick Combreau, Product Manager, Quotalys Ltd