Freigeben über

<remarks> (Visual Basic)

  • Artikel

Gibt einen Hinweisabschnitt für den Member an.

<remarks>description</remarks>

Parameter

  • description
    eine Beschreibung des Members.

Hinweise

Verwenden Sie das <remarks>-Tag, um Informationen über einen Typ hinzuzufügen und die mit <summary> (Visual Basic) angegebenen Informationen zu ergänzen. Diese Informationen werden im Objektkatalog angezeigt.

Dokumentationskommentare werden zu einer Datei verarbeitet, indem sie mit /doc kompiliert werden.

Beispiel

In diesem Beispiel wird mit dem <remarks>-Tag erläutert, was von der UpdateRecord-Funktion zurückgegeben wird.

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

Referenz

Empfohlene XML-Tags für Dokumentationskommentare (Visual Basic)