<paramref> (Visual Basic)

将单词格式化为参数。

语法

<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

另请参阅

• XML 注释标记