Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

XML Comments in C# don't show summary they show xml

Tags:

comments

c#

xml

I have regions and various methods within those regions. When I add XML comments to the top of the methods and collapse the xml comment it shows something like "/// ..." which is ueseless. How can I make it show the content inside the summary tag when collapsed.

VS 2008 Pro .NET 3.5 SP1

Thanks!

Matt

like image 321
Mathew A. Avatar asked Nov 05 '22 22:11

Mathew A.


1 Answers

If you write the summary out all in one line, such as:

/// <summary>My summary.</summary>

... you will see the summary when collapsed.

Frankly, I don't like this approach, because my summaries are usually longer than fits comfortably on one line.

like image 83
kbrimington Avatar answered Nov 10 '22 19:11

kbrimington