<示例> (Visual Basic)

指定成员的示例。

语法

<example>description</example>  

参数

description
代码示例的说明。

注解

借助 <example> 标记,可以指定如何使用方法或其他库成员的示例。 这通常涉及使用 <代码> 标记。

使用 -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

另请参阅