CODEWITHSUNDEEP
c#visual-studiovisual-studio-2017xml-comments
Neph
Neph

Reputation: 2001

Visual Studio 2017: <list> not showing correctly on hover (xml documentation)

If you hover over something (class, method,...) that's got xml documentation (///<summary></summary>) in VS17 (15.6.2), you get this little popup that shows the comments properly formatted.

I tried to make a list (copied from here):

/// <summary>Here is an example of a bulleted list:
/// <list type="bullet">
/// <item>
/// <description>Item 1.</description>
/// </item>
/// <item>
/// <description>Item 2.</description>
/// </item>
/// </list>
/// </summary>

But the popup only displays it in a single line:

Here is an example of a bulleted list: Item 1. Item 2.

I also tried to add <term> to it (like here) but all I get is:

enter image description here

I've tried with the other types too (and also without) but no change. Is this a bug? How do I fix it?

Upvotes: 6

Views: 853

Answers (1)

Alex David
Alex David

Reputation: 11

This is my workaround:

/// <summary>Here is an example of a bulleted list:
/// <list type="bullet">
/// <item>
/// <description><para>&#x02022; Item 1.</para></description>
/// </item>
/// <item>
/// <description><para>&#x02022; Item 2.</para></description>
/// </item>
/// </list>
/// </summary>

Upvotes: 1

Related Questions