<see> (Visual Basic)

指定指向其他成员的链接。

语法

<see cref="member"/>  

参数

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

注解

使用 <see> 标记从文本中指定链接。 使用 <seealso> 指示想要在“另请参阅”部分中显示的文本。

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