Udostępnij za pośrednictwem

<paramref> (Visual Basic)

  • Artykuł

Formaty programu word jako parametr.

<paramref name="name"/>

Parametry

  • name
    Nazwa parametru do odwoływania się do.Nazwę należy ująć w podwójny cudzysłów ("").

Uwagi

<paramref> Tag daje sposób, aby wskazać, że program word jest parametrem.Plik XML mogą być przetwarzane do sformatowania tego parametru w jakiś sposób distinct.

Kompiluj z /doc do procesu komentarzy dokumentacji do pliku.

Przykład

W tym przykładzie użyto <paramref> tag, aby odwołać się do id parametru.

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

Zobacz też

Informacje

Zalecane tagów XML dla komentarzy dokumentacji (Visual Basic)