Simple method annotation
suggest changeDocumentation 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:
![](/essential/csharp/img/108e9d14540b7d5ec572d98706a2d3becf492b2d.png)
See also Microsoft’s list of common documentation tags.
Found a mistake? Have a question or improvement idea?
Let me know.
Table Of Contents