Share via

<param> (Visual Basic)

  • Artikel

Definiert einen Parameternamen und eine Parameterbeschreibung.

<param name="name">description</param>

Parameter

  • name
    der Name des Methodenparameters. Der Name muss in doppelte Anführungszeichen (" ") eingeschlossen werden.

  • description
    eine Beschreibung für den Parameter.

Hinweise

Das <param>-Tag sollte im Kommentar für eine Methodendeklaration verwendet werden, um einen der Parameter der Methode zu beschreiben.

Der Text für das <param>-Tag wird in Parameterinfo und im Objektkatalog angezeigt.

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

Beispiel

In diesem Beispiel wird das <param>-Tag zur Beschreibung des id-Parameters verwendet.

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