Context Help

There are three types of context-sensitive help:

  1. Whole topic is shown when you point to some member in source code or Object Browser and press F1.
  2. Quick summary is shown in IntelliSense and Object Browser.
  3. Short property description is shown in Properties Window.

F1 Context help

To see Visual Studio dynamic help integration including context-sensitive help, go to the code editor and select expression with some method, property or other documented member. If you press F1, the proper topic should appear.

You can also press F1 on a member in Object Browser to invoke the help topic.

IntelliSense and Object Browser Quick Info

If you create a project with reference to your DLL and you use methods or properties from that DLL, IntelliSense in Visual Studio automatically shows their description and description of parameters as you write them. Description of a method or a property is taken from their <summary> tag in comments.

IntelliSense auto-completion


IntelliSense description

You can see the summary information in Object Browser as well.

Your API description in Object Browser

Property Description in Properties Window

When you select any property of a control or a component in Properties Window, you can see a short description.

Description in Properties Window

This description is not extracted from your comments but from Description attribute of your property. So if you wish to display this info you need to define Description attribute:

[System.ComponentModel.Description("Indicates button state.")]
public bool Pushed

VSdocman offers an easy way to do it through context menu.


Start generating your .NET documentation now!
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.

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

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