据我所知,在 C# 类型/方法的 XML 注释中,可以在标签中引用泛型类型,如下所示:
///<see cref="name.space.typename<T&rt;(paramtype)">
但我认为,还有另一种语法,不太笨拙?有些东西,要摆脱那些 html 实体“
以下是一篇不再可用的关于文档的好文章的引用:
编译器团队决定改进
通过允许替代语法来实现这一点
引用泛型类型和方法
在文档评论中。具体来说,
而不是使用打开和关闭
尖括号使用是合法的
打开和关闭花括号。这
上面的例子将变成:
class Program
{
/// <summary>
/// DoSomething takes a <see cref="List{T}"/>
/// </summary>
void DoSomething(List<int> al) { }
}
所以,就你而言:
///<see cref="name.space.typename{T}(paramtype)"/>
以下是 Microsoft 提供的一些最新参考资料:
- XML 文档注释(C# 编程指南) https://learn.microsoft.com/en-us/dotnet/csharp/programming-guide/xmldoc/xml-documentation-comments
- 使用 XML 注释记录您的代码 https://learn.microsoft.com/en-us/dotnet/csharp/codedoc
本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系:hwhale#tublm.com(使用前将#替换为@)