Documentation comments do not show when minimized

Question

When writing an XML comment in C# it looks like the below, but when you minimize it then all you see is the summary title instead of the summary that you actually typed. In VB.Net it works the way i would expect and displays the comment text when minimized. Any way to adjust this behaviour through an extension or otherwise?

Regular

    /// <summary>
    ///     Some Comment
    /// </summary>
    public int MyProperty { get; set; }

Minimized

    |/// <summary> ...|
    public int MyProperty { get; set; }

Ideal Minimized

    | Some Comment |
    public int MyProperty { get; set; }

Update. Here is an example from VB.Net. I can't believe i am saying this, but it would be great if C# would work the same way.

Regular

    ''' <summary>
    ''' Some Comment
    ''' </summary>
    ''' <remarks></remarks>
    Sub Main()

    End Sub

Minimized

    |Some Comment|
    Sub Main()

    End Sub

This is more of a visual-studio related question. What version are you using? — Forest Kunecke
– Forest Kunecke, Commented Aug 13, 2014 at 21:55
No, this is the way Visual Studio is designed. It is consistent with the code-folding behavior that occurs everywhere else besides comments. — Robert Harvey
– Robert Harvey, Commented Aug 13, 2014 at 21:58
try deleting the comments and starting over.. but if you hover over the minimized you will probably see the code snippet — MethodMan
– MethodMan, Commented Aug 13, 2014 at 21:58
@RobertHarvey I always wondered about this too; I think the focus of the question is whether there are any extensions or add-ins that can do this. — Forest Kunecke
– Forest Kunecke, Commented Aug 13, 2014 at 21:59

Robert Harvey · Accepted Answer · 2014-08-13 22:16:23Z

2

Visual Studio always collapses to the first line of text in a block, whatever that is. If you want to see the summary when an XML comment is collapsed, you have to put it on the first line, line this:

/// <summary>Some Comment</summary>
/// <remarks>
/// </remarks>
public int MyProperty { get; set; }

Which collapses to

/// <summary>Some Comment</summary> ...
public int MyProperty { get; set; }

answered Aug 13, 2014 at 22:16

Robert Harvey

182k48 gold badges349 silver badges516 bronze badges

Sign up to request clarification or add additional context in comments.

Collectives™ on Stack Overflow

Documentation comments do not show when minimized

1 Answer 1

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

Comments

Your Answer

Sign up or log in

Post as a guest

Related