<summary> (Visual Basic)

指定成員的摘要。

語法

<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

另請參閱

• XML 註解標籤