Sdílet prostřednictvím

<remarks> (Visual Basic)

  • Článek

Určuje oddíl Poznámky pro člen.

<remarks>description</remarks>

Parametry

  • description
    Popis členů.

Poznámky

Použití <remarks> značku přidat informace o typu, doplňující informace, s <summary> (Visual Basic).

Tyto informace se zobrazí v prohlížeči objektů.Informace o prohlížeči objektů, Zobrazení struktury kódu.

Kompilace s /doc k procesu dokumentační komentáře do souboru.

Příklad

V tomto příkladu <remarks> značku vysvětlit, co UpdateRecord 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

Viz také

Referenční dokumentace

Doporučené značky XML pro komentáře k dokumentaci (Visual Basic)