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

66

据我所知,在C#类型/方法的XML注释中,可以使用<see>标签来引用泛型类型:

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

但是我想还有另一种语法,它更简便一些? 有什么方法可以摆脱那些HTML实体“<”吗? 我现在找不到它。 有人能帮忙吗?

2个回答

82

这是一篇关于文档的好文章,但现在已经无法获取:

编译器团队决定改进这一点,通过允许在文档注释中使用另一种语法来引用泛型类型和方法。具体来说,可以使用大括号而非尖括号。上面的示例将变为:

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

所以,在你的情况下:
///<see cref="name.space.typename{T}(paramtype)"/>

以下是关于微软的两个较新参考资料:

7
是的,但是在 Visual Studio (2005..2012) Intellisense 中,花括号会显示为{T},而不是<T> - Pierre Arnaud
3
值得一提的是,Visual Studio 2015 中基于 Roslyn 的语言分析现在在工具提示中将 List<T> 的引用正确显示为 'List<T>' 而不是 'List{T}'。 - Theo Yaung

9

使用花括号:

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

网页内容由stack overflow 提供, 点击上面的
可以查看英文原文,
原文链接