XML代码注释中对泛型类型的引用

Question

据我所知，在C＃类型/方法的XML注释中，可以像这样引用标记中的泛型类型：

///<see cref="name.space.typename&lt;T&rt;(paramtype)">

但我认为，还有另一种语法，不那么笨拙？什么，摆脱那些HTML实体'＆lt;'？我现在找不到它。有人可以帮忙吗？

Answer 1

这是一篇关于文档的好文章：C# XML documentation comments FAQ

  

编译团队决定改进   通过允许替代语法   引用泛型类型和方法   在doc评论中。特别，   而不是使用打开和关闭   角括号使用它是合法的   打开和关闭花括号。该   上面的例子将成为：

class Program
{
    /// <summary>
    /// DoSomething takes a <see cref="List{T}"/>
    /// </summary>
    void DoSomething(List<int> al) { }
}

所以，在你的情况下：

///<see cref="name.space.typename{T}( paramtype )" />

编辑：上面的链接有点破碎;显示原始html。暂时离开链接。以下是Microsoft的一些较新的参考资料：

• XML Documentation Comments (C# Programming Guide)
• Documenting your code with XML comments

Answer 2

使用大括号：

///<see cref="name.space.typename{T}(paramtype)">