Skip to content
Permalink
Branch: master
Find file Copy path
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
54 lines (39 sloc) 2.6 KB
title ms.custom ms.date f1_keywords helpviewer_keywords ms.assetid
XML Documentation Comments - C# Programming Guide
seodec18
07/20/2015
cs.xml
XML [C#], code comments
comments [C#], XML
documentation comments [C#]
C# source code files
C# language, XML code comments
XML documentation comments [C#]
803b7f7b-7428-4725-b5db-9a6cff273199

XML Documentation Comments (C# Programming Guide)

In Visual C# you can create documentation for your code by including XML elements in special comment fields (indicated by triple slashes) in the source code directly before the code block to which the comments refer, for example:

/// <summary>  
///  This class performs an important function.  
/// </summary>  
public class MyClass {}  

When you compile with the -doc option, the compiler will search for all XML tags in the source code and create an XML documentation file. To create the final documentation based on the compiler-generated file, you can create a custom tool or use a tool such as DocFX or Sandcastle.

To refer to XML elements (for example, your function processes specific XML elements that you want to describe in an XML documentation comment), you can use the standard quoting mechanism (< and >). To refer to generic identifiers in code reference (cref) elements, you can use either the escape characters (for example, cref="List&lt;T&gt;") or braces (cref="List{T}"). As a special case, the compiler parses the braces as angle brackets to make the documentation comment less cumbersome to author when referring to generic identifiers.

[!NOTE] The XML documentation comments are not metadata; they are not included in the compiled assembly and therefore they are not accessible through reflection.

In This Section

Related Sections

For more information, see:

C# Language Specification

[!INCLUDECSharplangspec]

See also

You can’t perform that action at this time.