<seealso> (Visual Basic)

  • Artykuł

Określa, która pojawia się w sekcji Zobacz też łącze.

<seealso cref="member"/>

Parametry

  • member
    Odwołanie do członka lub pole, które jest dostępne zostać wywołana z bieżącego środowiska kompilacji.Kompilator sprawdza, czy element dany kod istnieje i przekazuje member do nazwy elementu w danych wyjściowych XML.membermuszą się pojawiać w podwójny cudzysłów ("").

Uwagi

Użyj <seealso> tag, aby określić tekst, który ma być wyświetlany w sekcji Zobacz też.Użyj <see> (Visual Basic) Aby określić łącze z tekstu.

Kompiluj z /doc do procesu komentarzy dokumentacji do pliku.

Przykład

W tym przykładzie użyto <seealso> tag w DoesRecordExist uwagi sekcji do odwoływania się do UpdateRecord 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 też

Informacje

Zalecane tagi XML dla komentarzy dokumentacji (Visual Basic)