Geek Answers Handbook

C # XML comments don't show the summary they show xml

I have regions and various methods in these regions. When I add XML comments to the top of the methods and collapse the xml comment, it shows something like "/// ..." which does not make sense. How can I make it display the contents inside the summary tag when collapsing.

VS 2008 Pro .NET 3.5 SP1

Thank!

Matt

+5
source share
2 answers

If you write the summary information in one line, for example:

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

... you will see a summary when collapsing.

Honestly, I do not like this approach because my resumes are usually longer than convenient on the same line.

+2
source

. XML, :

    /// <summary>The most important part of your comment on the first line
    /// and other stuff following on subsequent lines.</summary>
    public static void DoStuff()
    {
        // ...
    }

:

    /// <summary>The most important part of your comment on the first line ...
    public static void DoStuff() ...
0

More articles:


All Articles