<see> (Visual Basic)

Określa link do innego elementu członkowskiego.

Składnia

<see cref="member"/>  

Parametry

member
Odwołanie do elementu członkowskiego lub pola, które jest dostępne do wywołania z bieżącego środowiska kompilacji. Kompilator sprawdza, czy dany element kodu istnieje i przekazuje member do nazwy elementu w wyjściowym kodzie XML. member musi znajdować się w podwójnym cudzysłowie (" ").

Uwagi

Użyj tagu , <see> aby określić link z poziomu tekstu. Użyj <polecenia seealso> , aby wskazać tekst, który może być wyświetlany w sekcji "Zobacz również".

Skompiluj za pomocą -doc , aby przetworzyć komentarze dokumentacji do pliku.

Przykład

W tym przykładzie użyto tagu <see>UpdateRecord w sekcji uwagi, aby odwołać się do DoesRecordExist metody .

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

Zobacz także

• Tagi komentarzy XML