VB.NET：如何在XML文档中引用通用类和方法

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？

- Ignacio Calvo

Answer 1

似乎在 VS2012 中无法进行此操作，但是在 VS2013 中已经修复；您只需简单地编写<see cref="FancyClass(Of T)" />。

- Ignacio Calvo

---

定义'fixed'...每隔两到三次我写'cref='时似乎会使VS崩溃！！ - Grim

Answer 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）：这不是一个类。

- Frédéric THEVENON

---

我想在xml-doc注释中写类似于<see cref="FancyClass{T}" />（这是C#的方式）。看起来这个问题已经在VS2013中得到了解决。 - Ignacio Calvo

顺便说一句，“FancyClass(Of String)”肯定是一个类（你可以创建该类的实例）；“FancyClass(Of T)”只是一个类模板，你不能创建这个东西的对象实例。 - Ignacio Calvo

没错，当我说它不是一个类时，我是以xml-doc的方式思考的：你不能写<see cref="FancyClass(Of String)" />。 - Frédéric THEVENON