<value> (Visual Basic)

  • [アーティクル]

更新 : 2007 年 11 月

プロパティの説明を指定します。

<value>property-description</value>

パラメータ

  • property-description
    プロパティの説明。

解説

プロパティの説明を記述するには、<value> タグを使用します。Visual Studio 開発環境のコード ウィザードを使って追加したプロパティには、<summary> (Visual Basic) タグが追加されます。そのプロパティが表す値の説明を記述するには、<value> タグを手動で追加する必要があります。

コンパイル時に /doc を指定すると、ドキュメント コメントをファイルに出力できます。

使用例

<value> タグを使用して、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)