引用XML代码中的genericstypes注释
据我所知,在C#types/方法的XML注释中,可以在标签中引用genericstypes,如下所示:
///<see cref="name.space.typename<T&rt;(paramtype)">
但是我认为,还有另一种语法,这不是笨拙的? 有些东西,摆脱这些HTML实体“<”? 我现在找不到它。 有人可以帮忙吗?
这里有一篇关于文档的好文章: C#XML文档评论FAQ
编译器团队决定通过允许替代语法在文档注释中引用genericstypes和方法来改进这一点。 具体来说,不是使用打开和closures的尖括号,而是使用打开和closures的大括号是合法的。 上面的例子会变成:
class Program { /// <summary> /// DoSomething takes a <see cref="List{T}"/> /// </summary> void DoSomething(List<int> al) { } }
所以,在你的情况下:
///<see cref="name.space.typename{T}( paramtype )" />
使用大括号:
///<see cref="name.space.typename{T}(paramtype)">