<example> (Visual Basic)

  • [アーティクル]

更新 : 2007 年 11 月

メンバの例を指定します。

<example>description</example>

パラメータ

  • description
    サンプル コードの説明。

解説

<example> タグでは、メソッドやその他のライブラリ メンバの使用例を指定します。<code> (Visual Basic) タグと組み合わせて使用するのが一般的です。

コンパイル時に /doc を指定してドキュメント コメントをファイルに出力します。

使用例

この例では、<example> タグを使用して、ID フィールドの使用例を含めます。

Public Class Employee
    ''' <remarks>
    ''' <example> This sample shows how to set the <c>ID</c> field.
    ''' <code>
    ''' Dim alice As New Employee
    ''' alice.ID = 1234
    ''' </code>
    ''' </example>
    ''' </remarks>
    Public ID As Integer
End Class

参照

参照

ドキュメント コメントとして推奨される XML タグ (Visual Basic)