<see> (Visual Basic)
更新:2007 年 11 月
指定至另一個成員的連結。
<see cref="member"/>
參數
- member
對可以從目前編譯環境呼叫的成員或欄位的參考。編譯器會檢查指定的程式碼項目是否存在,並將 member 傳遞給 XML 輸出檔案中的項目名稱。member 必須出現在雙引號 (" ") 中。
備註
使用 <see> 標記 (Tag),從文字中指定連結。使用 <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