【问题标题】:VB.NET: How to reference generic classes and methods in xml documentationVB.NET:如何在 xml 文档中引用泛型类和方法
【发布时间】:2012-08-08 06:44:49
【问题描述】:

注意:这是this question 的副本,但适用于 Visual Basic 而不是 C#。

在编写 XML 文档时,您可以使用<see cref="something">something</see>,这当然可以。但是如何引用具有泛型类型的类或方法呢?

Public Class FancyClass(Of T)

  Public Function  FancyMethod(value As T) As String
    Return "something fancy"
  End Function

End Class

如果我要在某处编写 xml 文档,我将如何引用花哨的类?如何引用FancyClass(Of String)?方法呢?

例如,在另一个类中,我想让用户知道我将返回一个FancyClass(Of Integer) 的实例。我怎么能为此做一个see cref 的东西?

【问题讨论】:

    标签: vb.net generics reference xml-documentation


    【解决方案1】:

    在VS2012中好像不能做这个事情,但是在VS2013中已经修复了;你可以直接写<see cref="FancyClass(Of T)" />

    【讨论】:

    • Define 'fixed' ...似乎每隔一次/第三次我写一个 'cref=' 时 VS 就会崩溃!!
    【解决方案2】:

    我习惯写这样的东西:

    ''' <summary>
    ''' A great fancy class.
    ''' </summary>
    ''' <typeparam name="T">Generic stuff ....</typeparam>
    Public Class FancyClass(Of T)
    
        ''' <summary>
        ''' A fancy method that do fancy operation.
        ''' </summary>
        ''' <param name="value">The value.</param>
        ''' <returns></returns>
        Public Function FancyMethod(value As T) As String
            Return "something fancy"
        End Function
    
    End Class
    

    xml 文档必须谈论您的泛型类。你永远不会引用FancyClass(Of String):这不是一个类。

    【讨论】:

    • 我想在 xml-doc 注释中写类似 &lt;see cref="FancyClass{T}" /&gt; 的内容(这是 C# 方式)。看来这个问题在VS2013中已经修复了。
    • 顺便说一句,FancyClass(Of String 肯定是一个类(您可以创建该类的实例); FancyClass(Of T) 只是一个类模板;你不能创建那个东西的对象实例。
    • 是的,当我说它不是一个类时,我用 xml-doc 的方式想:你不能写&lt;see cref="FancyClass(Of String)" /&gt;
    猜你喜欢
    • 1970-01-01
    • 2010-10-15
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 2013-08-11
    • 2021-04-08
    • 2020-12-20
    相关资源
    最近更新 更多