VB.NET:如何在xml文档中引用泛型类和方法

时间:2012-08-08 06:44:50

标签: vb.net generics reference xml-documentation

注意:这是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的事情呢?

2 个答案:

答案 0 :(得分:2)

似乎你不能在VS2012中做这件事,但它已在VS2013中修复;你可以简单地写<see cref="FancyClass(Of T)" />

答案 1 :(得分:0)

我习惯写这样的东西:

''' <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):这不是一个类。