通过

<example> (Visual Basic)

  • 项目

为成员指定示例。

<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)