通过

<remarks> (Visual Basic)

  • 项目

指定成员的备注部分。

<remarks>description</remarks>

参数

  • description
    成员的说明。

备注

使用 <remarks> 标记添加有关类型的信息，以此补充用 <summary> (Visual Basic) 指定的信息。 此信息显示在 对象浏览器 中。

使用 /doc 进行编译可以将文档注释处理到文件中。

示例

此示例使用 <remarks> 标记解释 UpdateRecord 方法的作用。

''' <param name="id">The ID of the record to update.</param>
''' <remarks>Updates the record <paramref name="id"/>.
''' <para>Use <see cref="DoesRecordExist"/> to verify that
''' the record exists before calling this method.</para>
''' </remarks>
Public Sub UpdateRecord(ByVal id As Integer)
    ' Code goes here.
End Sub
''' <param name="id">The ID of the record to check.</param>
''' <returns><c>True</c> if <paramref name="id"/> exists,
''' <c>False</c> otherwise.</returns>
''' <remarks><seealso cref="UpdateRecord"/></remarks>
Public Function DoesRecordExist(ByVal id As Integer) As Boolean
    ' Code goes here.
End Function

请参见

参考

建议的用于文档注释的 XML 标记 (Visual Basic)