• Increase font size
  • Default font size
  • Decrease font size

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 code editor and select expression with some method, property or other documented member.Now you should see the link in dynamic help window and if you press F1, the proper topic should appear.

F1 help for your component or control in Visual Studio

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

IntelliSense and Object Browser Quick Info

If you create the 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 method or 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 component in Properties Window, you can see 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 Property pushed() As Boolean

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

 

VSdocman

Start now!

Generate .NET documentation now! Download VSdocman now for a free, fully functional 14 day trial.

DOWNLOAD

The 14 day trial only counts days when program is actually used, not calendar days. There's no need to reinstall when you decide to purchase the full version.

VSdocman Tip

You can document also root namespace in VB .NET projects.

Which language do you use most?