Dispalying Documentation in the IDE for your own classes

[groovydaz]

How do you get the popup lists in the IDE for your own class to contain documentation for it. I added XML tags above some of my methods in the class but when I used the compiled class in a project I didnt see any othe the method descriptions. Is there a way to do this?

Darren.

[Jhd.Honza]

From MSDN:

To use the generated .xml file for use with the IntelliSense feature, let the file name of the .xml file be the same as the assembly you want to support and then make sure the .xml file is in the same directory as the assembly. Thus, when the assembly is referenced in the Visual Studio project, the .xml file is found as well.

Maybe you could post an example how you implement you documentation or how you compile it to see whether it should work.

[groovydaz]

Thanks a lot for finding that information for me, it works now, I just had to change the name of the xml file to the same name as my control.



Example comment:

/// <summary>
/// Add's an item to the ListBoxEx control
/// </summary>
/// <param name="item">
/// The object To Add
/// </param>

public void Add(object item) {
 ...
}

cheers,
Darren.