<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)