<remarks> (Visual Basic)

为成员指定注解部分。

语法

<remarks>description</remarks>  

参数

description
对成员的说明。

备注

使用 <remarks> 添加有关某个类型的信息，从而补充由 <summary> 指定的信息。

这些信息显示在对象浏览器中。 有关对象浏览器的信息，请参阅查看代码的结构。

使用 -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 注释标记