Special Comment

[#Hai]

Hi,
I noticed that there are some special piece of comments in the source-code
generated by Visual Studio.NET when we create a new C# projects.
These comments comes with tags like

/// <summary>
/// Clean up any resources being used.
/// </summary>

What is the purpose of tags <summary> ?
How to use these tag ?

 

[Jon Skeet]

[Again, this has nothing to do with most of the groups on the list...
Follow-ups set to the C# group only]

Hi,
I noticed that there are some special piece of comments in the source-code
generated by Visual Studio.NET when we create a new C# projects.
These comments comes with tags like

/// <summary>
/// Clean up any resources being used.
/// </summary>

What is the purpose of tags <summary> ?
How to use these tag ?

They're for XML documentation. Look up "XML documentation" in the index
of MSDN for lots of information about the topic.

 

[Herfried K. Wagner]

Hello,

I noticed that there are some special piece of comments in the source-code
generated by Visual Studio.NET when we create a new C# projects.
These comments comes with tags like

/// <summary>
/// Clean up any resources being used.
/// </summary>

What is the purpose of tags <summary> ?
How to use these tag ?

http://msdn.microsoft.com/library/en-us/csref/html/vclrfTagsForDocumentationComments.asp

Regards,
Herfried K. Wagner