Matthew Beck
Matthew Beck

Reputation: 359

What is the purpose of ///<comment> </comment> in Visual Studio

I searched the net and found no results explaining the usage of this comment block. Therefore, I hope someone can explain to me the reason behind this style of comment.

///<comment> Text goes here. </comment>

Upvotes: 0

Views: 149

Answers (3)

Thomas Matthews
Thomas Matthews

Reputation: 57718

They are also recognized by doxygen as documentation comments:
http://www.doxygen.nl/manual/docblocks.html

Edit 1: Correction
The beginning "///" is recognized by doxygen, not the </comment>.

Upvotes: 0

JudgeProphet
JudgeProphet

Reputation: 1729

It's XML syntax often use by Software aggregator and Visual Studio Itself to generate help/doc file. Such as Sandcastle

Upvotes: 1

Inisheer
Inisheer

Reputation: 20794

They are XML documentation comments.

http://msdn.microsoft.com/en-us/library/b2s063f7.aspx

Upvotes: 7

Related Questions