<param> (Visual Basic)

Článek
03/04/2013

Definuje parametr název a popis.

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

Parametry

name
Název parametru metody.Název uzavřete do uvozovek ("").
description
Popis parametru.

Poznámky

<param> Značky by měl být používán pro deklarace metody Poznámka popisující parametry pro metodu.

Text <param> značka se zobrazí v následujících umístěních:

Informace o parametru technologie IntelliSense.Další informace naleznete v tématu Pomocí technologie IntelliSense.
Prohlížeč objektů.Další informace naleznete v tématu Zobrazení struktury kódu.

Kompilace s /doc k procesu dokumentační komentáře do souboru.

Příklad

V tomto příkladu <param> značek popisují id parametr.

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

Referenční dokumentace

Doporučené značky XML pro komentáře k dokumentaci (Visual Basic)

Sdílet prostřednictvím