Documentation comments are placed directly above the method or class they describe. They begin with three forward slashes ///
, and allow meta information to be stored via XML.
/// <summary>
/// Bar method description
/// </summary>
public void Bar()
{
}
Information inside the tags can be used by Visual Studio and other tools to provide services such as IntelliSense:
See also Microsoft's list of common documentation tags.