Special Comment

TheMSsForum.com: The Microsoft Software Forum

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 ?
Top

Re: Special Comment by Jon

Jon
Sat Jun 28 05:17:36 CDT 2003

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

> #Hai <LHHai@SoftHome.net> wrote:
> 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.

--
Jon Skeet - <skeet@pobox.com>
http://www.pobox.com/~skeet/
If replying to the group, please do not mail me too
Top

Re: Special Comment by Herfried

Herfried
Sat Jun 28 05:54:11 CDT 2003

Hello,

" #Hai" <LHHai@SoftHome.net> schrieb:
> 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
--
MVP · VB Classic, VB .NET
http://www.mvps.org/dotnet


Top