在 Visual Studio 的 xml 注释中显示通用类，例如 Table<String>答案

【问题标题】：Showing generic class eg Table<String> in xml comments in visual studio在 Visual Studio 的 xml 注释中显示通用类，例如 Table<String>
【发布时间】：2010-09-30 20:34:54
【问题描述】：

我知道这可能是一个基本问题，但我似乎无法在任何地方找到答案。

我有这样的课

Table<T>
{}

然后我有一些使用上述类的代码，我想评论一下我希望能够执行以下操作：

/// <summary>
/// blah blah blah Table<String>
/// </summary>

但是我不能在评论中使用尖括号，因为它认为它是一个标签，当帮助出现时，它只是有一个关于没有结束标签的错误。

如何在 Visual Studio 的 cmets 中显示泛型类。

【问题讨论】：

标签： visual-studio comments

【解决方案1】：

尝试使用 <而不是

【讨论】：

【解决方案2】：

您需要使用 XML 实体（某种转义序列）： <对于。 Intellisense 将正确显示。

编辑：这是所有 XML 实体的备忘单：

&lt;   for <
&gt;   for >
&amp;  for &
&quot; for "
&apos; for '

【讨论】：

【解决方案3】：

< 的问题是它看起来很难看，在 cmets 中很难阅读。我使用以下内容：GenericThing≪T,U≫。那不是两个尖括号字符，而是一个字符。在 Intellisense 和读取 cmets 时，它看起来不错。如果您使用

等来输出文档，那么它并不完全正确，但它对我有用。

【讨论】：

【解决方案4】：

如果将其放在 cref 元素中，则可以改用 { 和 }。
也就是说，在摘要中，您输入的是<cref="Table{string}"/>，而不是Table<string>

来自XML Documentation Comments：

要在代码引用中引用通用标识符...作为一种特殊情况，编译器将 [crefs] 中的大括号解析为尖括号，以使文档注释在引用通用标识符时对作者来说不那么繁琐。

有关cref的更多信息，请参阅cref Attribute：

XML 文档标签中的cref 属性表示“代码引用”。它指定标记的内部文本是代码元素，例如类型、方法或属性。 DocFX 和 Sandcastle 等文档工具使用 cref 属性自动生成指向记录类型或成员的页面的超链接。

注意：为方便起见，我有时使用{} 代替<>（在摘要评论中），即使不是cref 的一部分。

【讨论】：