Поделиться через

<seealso> (Visual Basic)

  • Статья

Указывает ссылку, которая отображается в разделе "Cм. также".

<seealso cref="member"/>

Параметры

  • member
    Ссылка на член или поле, которое может вызываться из текущей среды компиляции. Компилятор проверяет, существует ли данный элемент кода и передает ли он member имени элемента в выходных XML-данных. member необходимо заключать в двойные кавычки (" ").

Заметки

Используйте тег <seealso>, чтобы указать текст, который должен отображаться в разделе "См. также". Используйте <see> (Visual Basic), чтобы указать ссылку в тексте

Чтобы выделить документирующие комментарии в отдельный файл, необходимо использовать при компиляции параметр /doc.

Пример

Этот пример использует тег <seealso> в разделе примечаний DoesRecordExist для ссылки на метод 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-теги для комментариев документации (Visual Basic)