通过

<see> (Visual Basic)

  • 项目

指定到另一成员的链接。

<see cref="member"/>

参数

  • member
    对可以通过当前编译环境进行调用的成员或字段的引用。 编译器检查给定的代码元素是否存在，并将 member 传递给输出 XML 中的元素名称。 member 必须位于双引号 (" ") 中。

备注

使用 <see> 标记从文本内指定链接。 使用 <seealso> (Visual Basic) 指示希望在“请参见”一节中出现的文本。

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

示例

本示例使用 UpdateRecord 备注部分中的 <see> 标记来引用 DoesRecordExist 方法。

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