VSdocman Help  

Context Help Options

Go to Add-Ins -> VSdocman menu or press VSdocman button on standard toolbar. Options dialog appears. Set Compile - 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.

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> (or @param) tags.

 

 

It doesn't work if you reference project, you must reference compiled DLL.

You can see the summary information in Object Browser as well. However, it seems it doesn't work with custom controls there. IntelliSense works even with custom controls.

 

 

See Also

VSdocman Options | View and Deploy Context Help