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:
I've tried with the other type
s too (and also without) but no change. Is this a bug? How do I fix it?
This is my workaround:
/// <summary>Here is an example of a bulleted list:
/// <list type="bullet">
/// <item>
/// <description><para>• Item 1.</para></description>
/// </item>
/// <item>
/// <description><para>• Item 2.</para></description>
/// </item>
/// </list>
/// </summary>
If you love us? You can donate to us via Paypal or buy me a coffee so we can maintain and grow! Thank you!
Donate Us With