通过

<summary> (Visual Basic)

  • 项目

指定成员的摘要。

<summary>description</summary>

参数

  • description
    对象的摘要。

备注

使用 <summary> 标记说明类型或类型成员。 使用 <remarks> (Visual Basic) 将补充信息添加到类型说明。

<summary> 标记的文本是唯一的信息源有关类型的在 IntelliSense 和还显示在"对象浏览器"。 有关对象浏览器的信息，请参见 查看代码的结构。

使用 /doc 进行编译可以将文档注释处理到文件中。

示例

本示例使用 <summary> 标记说明 ResetCounter 方法和 Counter 属性。

''' <summary>
''' Resets the value the <c>Counter</c> field.
''' </summary>
Public Sub ResetCounter()
    counterValue = 0
End Sub
Private counterValue As Integer = 0
''' <summary>
''' Returns the number of times Counter was called.
''' </summary>
''' <value>Number of times Counter was called.</value>
Public ReadOnly Property Counter() As Integer
    Get
        counterValue += 1
        Return counterValue
    End Get
End Property

请参见

参考

建议的用于文档注释的 XML 标记 (Visual Basic)