C＃中的XML注释不显示它们显示xml的摘要

Question

我在这些地区拥有地区和各种方法。当我将XML注释添加到方法的顶部并折叠xml注释时，它会显示类似“/// ...”的内容，这是无效的。如何在折叠时显示摘要标记内的内容。

VS 2008 Pro .NET 3.5 SP1

谢谢！

马特

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() ...