将一个词格式化为参数。
<paramref name="name"/>
参数
- name
要引用的参数名。 将此名称用双引号括起来 (" ")。
备注
<paramref> 标记为您提供了一种指示词为参数的方法。 可以处理 XML 文件，从而用某种独特的方法格式化该参数。
使用 /doc 进行编译可以将文档注释处理到文件中。
示例
本示例使用 <paramref> 标记引用 id 参数。
''' <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