Sdílet prostřednictvím

<poznámky> (Visual Basic)

  • Článek

Určuje oddíl poznámek pro člena.

Syntaxe

<remarks>description</remarks>

Parametry

description
Popis člena.

Poznámky

<remarks> Značka slouží k přidání informací o typu a doplnění informací zadaných souhrnem<>.

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

Zkompilujte pomocí -doc a zpracujte komentáře dokumentace k souboru.

Příklad

V tomto příkladu se <remarks> značka používá k vysvětlení toho, co UpdateRecord metoda dělá.

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