Go to Add-Ins - VSdocman menu or press VSdocman button on standard toolbar. VSdocman dialog appears, select Project Properties pane. Set Output - Context Help page.
If this option is checked, IntelliSense and Object Browser quick info will be generated (F1 help is always generated).
This type of context-sensitive help works with ANY output format, including RTF, HTML, XML and others.
VSdocman generates special XML file called PROJECT_NAME.xml in your project folder (not output folder). You must place it manually in the folder where the resulting DLL file is placed and restart VS .NET.
Checking this option is only necessary for VB .NET in Visual Studio 2002 and 2003. For C# and VB .NET 2005 and higher, you can do it directly in Visual Studio:
- For a Visual Basic project, on the Project menu, click Properties and then Compile tab. On the Compile page, select Generate XML documentation file.
- For a C# project, on the Project menu, click Properties and then Build tab. On the Build page, select XML documentation file.
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.
Description of parameters is taken from <param> tags.
In VS 2002/2003, it doesn't work if you reference project, you must reference compiled DLL. You can see the summary information in Object Browser as well.
|
