Newsletter

Sign up for our free newsletter. Your email address will only be used to send out the newsletter.


RSS Feeds

Product news

Home arrow Products arrow VSdocman arrow On-line Help arrow Context Help

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 .NET 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 (in VS 2002 ans 2003) 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. In VS 2005, you can even get Intellisense for members from current project.

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.
 
 
© Copyright 2008 Helixoft All rights reserved. | Privacy Statement