Microsoft has all sorts of documented xml tags for doc comments (beginning with a triple-slash), but some of them (e.g. <list>
) don't actually change the formatting of the tooltip text IntelliSense gives me, and instead it just gets thrown in a jumbled heap:
These are the doc comments that produced that tooltip:
/// <summary>
/// <code>None of this gets formatted</code>
/// Test list:
/// <list type="number"><listheader><term>testT</term><description>testD</description></listheader>
/// <item><term>This gets</term><description>crammed</description></item></list>
/// See <see cref="unixEpoch"/>
/// </summary>
/// <param name="date"></param>
/// <param name="TimeZoneOption"></param>
/// <returns>Things that have <code>code</code></returns>
So my questions are:
- It seems to be that anything that isn't starred in the MS doc is just ignored for IntelliSense purposes, but why even have a
<code>
tag if the text inside isn't going to look any different? - Why does the
<returns>
part not show up in the tooltip at all? - Is there any way to force a newline that I'm missing?