共用方式為

<example> (Visual Basic)

  • 發行項

指定成員的範例。

<example>description</example>

參數

  • description
    為程式碼範例的描述。

備註

<example> 標記 (Tag) 讓您指定一個範例，說明如何使用方法或其他程式庫成員。這通常會包含 <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)