指定指向另一个成员的链接。
语法
<see cref="member"/>
参数
member
对可从当前编译环境调用的成员或字段的引用。 编译器检查是否存在给定的码位元素,并将 member
传递到输出 XML 中的元素名称。
member
必须出现在双引号 (“ ) 内。
注解
使用 <see>
标记从文本中指定链接。 使用 <seealso> 指示可能需要显示在“另请参阅”部分中的文本。
使用 -doc 编译以处理对文件的文档注释。
示例:
此示例使用 <see>
备注部分中的标记 UpdateRecord
来引用该方法 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