XML 注释 <list> 未在 IntelliSense 中显示

Question

我正在尝试让 VB.NET XML 注释与 IntelliSense 一起工作，但它可能不像我认为的那样工作。

    ''' <summary>
    ''' Gets or sets the Patient Code.
    ''' <list type="bullet">
    ''' <listheader><description>Validation:</description></listheader>
    ''' <item><description>Field Required</description></item>
    ''' <item><description>Field Max Length: 25</description></item>
    ''' </list>
    ''' </summary>
    ''' <value>The region reference key.</value>

当您输入函数时，这应该显示“获取或设置患者代码”，然后在其下方显示带有“验证：”作为标题的项目符号列表？

alt text http://www.codejames.com/errored.jpg

也许我做错了，但它似乎无法正常工作。

Answer 1

您没有正确执行此操作，只是不支持它。虽然 HTML 标记可能出现在某些工具的输出中，但 IntelliSense 不是其中之一。

IntelliSense 是 Visual Studio 2008 中的文本显示，我们不支持显示许多/大部分标记，因为它们应该出现在 HTML 样式显示中。相反，我们倾向于去除不支持的标记标签并显示结果文本。

Answer 2

您可以通过用<para> 标签包围<description> 内容来“伪造”它（没有数字）——这至少会在 Intellisense 中很好地显示出来，但没有适当的列表分隔符（项目符号、数字)。

<summary>
Gets or sets the Patient Code.
<list type="bullet">
<listheader><description>Validation:</description></listheader>
<item><description>Field Required</description></item>
<item><description>Field Max Length: 25</description></item>
</list>
</summary>
<value>The region reference key.</value>

如果您不太关心生成的输出，只需在每一行中添加您的项目符号：

<item><description><para>* Field Required</para></description></item>

另见<list> XML Documentation

更新

自发布此消息以来，VS2012 11.0.60610.01 Update 3 似乎添加了格式支持，因此您不再需要 <para> 内部包装或添加自己的项目符号。