Udostępnij za pośrednictwem

<remarks> (Visual Basic)

  • Artykuł

Określa sekcja uwagi dla elementu członkowskiego.

<remarks>description</remarks>

Parametry

  • description
    Opis elementu członkowskiego.

Uwagi

Użycie <remarks> tag, aby dodać informacje o typie, uzupełniające informacje określone z <summary> (Visual Basic).

Te informacje są wyświetlane w przeglądarce obiektów.Aby uzyskać informacje o przeglądarce obiektów, zobacz Wyświetlanie struktury kodu.

Kompilacji z /doc do procesu dokumentacji komentarze do pliku.

Przykład

W poniższym przykładzie użyto <remarks> tag, aby wyjaśnić, co UpdateRecord czy metoda.

''' <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 tagów XML dla komentarzy dokumentacji (Visual Basic)