指定成员的摘要。
语法
<summary>description</summary>
参数
description
对象的摘要。
注解
使用 <summary>
标记描述类型或类型成员。 使用 <remarks> 可针对某个类型说明添加补充信息。
标记的文本 <summary>
是 IntelliSense 中有关该类型的唯一信息来源,也显示在对象浏览器中。 有关对象浏览器的信息,请参阅 查看代码的结构。
使用 -doc 编译以处理对文件的文档注释。
示例:
此示例使用 <summary>
标记来描述 ResetCounter
方法和 Counter
属性。
''' <summary>
''' Resets the value of 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