<Hinweise> (Visual Basic)

  • Artikel

Gibt einen Abschnitt mit Anmerkungen für das Element an.

Syntax

<remarks>description</remarks>

Parameter

description
Eine Beschreibung des Members

Hinweise

Das Tag <remarks> wird verwendet, um Informationen zu einem Typ hinzuzufügen. Dadurch werden die in der <Zusammenfassung> angegebenen Informationen ergänzt.

Diese Informationen werden im Objektbrowser angezeigt. Informationen zum Objektbrowser finden Sie unter Anzeigen der Struktur des Codes.

Kompilieren Sie mit -doc, um Dokumentationskommentare zu einer Datei zu verarbeiten.

Beispiel

In diesem Beispiel wird das <remarks>-Tag verwendet, um die Funktionsweise der UpdateRecord-Methode zu erläutern.

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

Siehe auch