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

你可以通过用<description>标记包围<para>内容来“伪造”它（没有数字） - 这至少会在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>内部包装或添加自己的项目符号。

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

2 个答案:

更新