XML Documentation

Question

Basic question here, but how would I reference the following (ie does it have a name). I looked on msdn and all I could find was they called is XML Documentation, which seems a bit misleading.

    /// <summary>
    /// This is a simple summary for my class
    /// </summary>
    /// <param name="foo"></param>
    /// <param name="bar"></param>

Not really important I guess, just curious.

Answer 1

It is called XML documentation.
Mainly because :

1. you write XML (after the ///) and
2. it produces XML files for further processing.

Answer 2

They are called XML Documentation Comments

When you compile with /doc option, the compiler will search for all XML tags in the source code and create an XML documentation file. You can then use a tool like Sandcastle to create a final documentation product based on the XML file.

Answer 3

That is known as XML Documentation -- at compile time, it can be output into an XML file by the compiler; this can then be fed into tools like Sandcastle to produce class library documentation.

Answer 4

They're probably right: XML Documentation Comments

"In Visual C# you can create documentation for your code by including XML tags in special comment fields in the source code directly before the code block they refer to."