<example> (Visual Basic)

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

構文

<example>description</example>  

パラメーター

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

注釈

<example> タグを使用すると、メソッドまたは他のライブラリ メンバーの使用例を指定できます。 これには一般的に、<code> タグの使用が含まれます。

-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 コメント タグ