<示例> (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

另请参阅