Комментарии XML в C # не показывают резюме, они показывают XML

Question

У меня есть регионы и различные методы в этих регионах.Когда я добавляю XML-комментарии в начало методов и сворачиваю xml-комментарий, он показывает что-то вроде «/// ...», что бесполезно.Как я могу сделать так, чтобы содержимое внутри тега сводки отображалось в свернутом виде.

VS 2008 Pro .NET 3.5 SP1

Спасибо!

Matt

Answer 1

Если вы записываете резюме в одну строку, например:

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

... вы увидите сводку в свернутом виде.

Честно говоря, мне не нравится этот подход, потому что мои резюме обычно длиннее, чем удобно помещается на одной строке.

Answer 2

Блок свернутых комментариев будет отображать первую строку комментария, пока вы его не развернете.Следовательно, вы можете отформатировать свои комментарии 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() ...