Delen via

<opmerkingen> (Visual Basic)

  • Artikel

Hiermee geeft u een sectie opmerkingen voor het lid.

Syntaxis

<remarks>description</remarks>

Parameters

description
Een beschrijving van het lid.

Opmerkingen

Gebruik de <remarks> tag om informatie over een type toe te voegen, met aanvulling op de informatie die is opgegeven met <een samenvatting>.

Deze informatie wordt weergegeven in de objectbrowser. Zie De structuur van code bekijken voor meer informatie over de objectbrowser.

Compileer met -doc om documentatieopmerkingen naar een bestand te verwerken.

Opmerking

In dit voorbeeld wordt de <remarks> tag gebruikt om uit te leggen wat de UpdateRecord methode doet.

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

Zie ook