What are XML Comments in C# Used For? [duplicate]

StackOverflow https://stackoverflow.com/questions/14450455

  •  17-01-2022
  •  | 
  •  

Question

Possible Duplicate:
What are the virtues of using XML comments in .NET? 

/// <summary>
///  Set error message for multilingual language.
/// </summary>

What is the use of XML Comments like the above in C# and when do i use them.. XML Comments come with 3 Quotes , Is there a block commenting process for XML Comments like /* ... */

Was it helpful?

Solution

XML comments are a structured way to document the types and members within your code. If you use this, the compiler will generate XML documentation for your types and members, which can then be processed via a tool like Sandcastle to build help automatically. The information in the generated XML files is also used by Visual Studio (to provide intellisense).

You can use multiline delimiters via:

/** <summary>
Your info here
*/

Although the tooling doesn't generate it in this form.

For details, see XML Documentation Comments on MSDN.

OTHER TIPS

Its a way to document your code. here is a reference

http://msdn.microsoft.com/en-us/magazine/dd722812.aspx

Licensed under: CC-BY-SA with attribution
Not affiliated with StackOverflow
scroll top