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!
DOWNLOAD
Free, fully functional trial
VSdocman Tip
Use <see langword="null"/> when you refer to null or Nothing in your comments. There are special tags also for other keywords such as true, false, abstract, etc.
Customers

Universities
Medical institutions
Government institutions
Large financial institutions
Thousands of SW companies

Deloitte & Touche
PricewaterhouseCoopers
Bloomberg
Wells Fargo
QBE

Caterpillar
Lear
DuPont
Pfizer

Boeing
Airbus
Rolls-Royce Naval Marine
Toyota Motorsport

Bose
Mitsubishi Electric
Johnson Controls
Bentley Systems

Intel
Hewlett Packard
Bosch (Australia)
Schneider Electric

Intergraph
Volvo Information Technology
SOPRA GROUP
Agilent Technologies
Tesco SW

Syncfusion
T-Systems
Verizon
Fraunhofer Heinrich-Hertz-Institut

vs launch partner logo

VS Mag award VS Mag award

I have been using VSdocman to provide C# .NET API integrated documentation for our customers for the past 7 years. Keeping up with Microsoft's Visual Studio version changes can be challenging for developers, but VSdocman has continued to provide excellent functionality that meet our requirements to satisfy internal and external users. This company also provides immediate excellent customer support when issues or confusion occur.

Edna Turner Stilwell, Staff Writer/.NET Lead