共用方式為

<summary> (Visual Basic)

  • 發行項

指定成員的摘要。

<summary>description</summary>

參數

  • description
    為物件的摘要。

備註

使用 <summary> 標記 (Tag)，來描述型別或型別成員。 使用 <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)