【问题标题】:reference to generic type in XML code comment [duplicate]在 XML 代码注释中引用泛型类型 [重复]
【发布时间】:2011-02-17 14:17:04
【问题描述】:

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

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

但我认为,还有另一种不那么笨拙的语法?一些东西,摆脱那些html实体'

【问题讨论】:

    标签: c# xml documentation reference generics


    【解决方案1】:

    这里引用了一篇不再可用的关于文档的好文章:

    编译器团队决定改进 这通过允许替代语法 引用泛型类型和方法 在 doc cmets 中。具体来说, 而不是使用打开和关闭 使用尖括号是合法的 打开和关闭花括号。这 上面的例子会变成:

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

    所以,在你的情况下:

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

    以下是 Microsoft 提供的一些较新的参考资料:

    【讨论】:

    • 是的,但花括号确实在 Visual Studio (2005..2012) Intellisense 中显示为 {T},而不是 &lt;T&gt;
    • @PierreArnaud - FWIW,Visual Studio 2015 中新的基于 Roslyn 的语言分析现在正确地将 List 的引用显示为 'List' 而不是 'List{T}'工具提示:)
    【解决方案2】:

    使用大括号:

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

    【讨论】:

      猜你喜欢
      • 1970-01-01
      • 2010-10-15
      • 1970-01-01
      • 2021-04-08
      • 1970-01-01
      • 1970-01-01
      • 2021-07-14
      • 1970-01-01
      • 1970-01-01
      相关资源
      最近更新 更多