#301 – Using XML Documentation at the Class Level
April 14, 2011 Leave a comment
In addition to adding context to Intellisense for method calls, XML Documentation can be used to provide Intellisense context for a class itself.
You add XML Documentation to a class by entering “///” on a blank line immediately preceding the class keyword. Visual Studio will create an empty template for you to fill in.
/// <summary> /// /// </summary> public class Dog {
To finish the documentation, enter a short description of the purpose of the class, within the <summary> tags.
/// <summary> /// Represents a Dog, one of our furry friends. Dogs can /// bark and do basic chores like fetching your newspaper. /// </summary> public class Dog {
If a class has XML Documentation at the class level, Intellisense will display that information when you enter the name of the class in your code.