Intellisense Documentation

Recently I was working on a class for part of a Windows Forms application that I’m working on. I wanted to have Intellisense documentation for the methods that I had defined in my class.

I documented the methods with the standard summary documentation

/// <summary>
///
/// </summary>

After I compiled the application I checked to make sure the Intellisense was working and to my surprise found that it wasn’t. I’ve used the Intellisense documentation in the past, but clearly I was missing something.

I did some searching on the documentation and found that I had forgotten to check the box for the XML documentation file on the project build properties.

Once I checked the XML documentation file checkbox and recompiled the application the Intellisense started working.

Also, if you plan on distributing the dll for the class, you have to ensure that you distribute the xml file with the dll and ensure that the xml and dll file are in the same directory.

Hope this helps other developers.