<param> (Visual Basic)

定义参数名称和说明。

语法

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

参数

name
方法参数的名称。 用双引号 (" ") 将名称引起来。

description
参数的说明。

备注

在方法声明的注释中，应使用 <param> 标记来描述方法参数之一。

<param> 标记的文本将出现在以下位置：

• IntelliSense 的参数信息。 有关详细信息，请参阅使用 IntelliSense。

• 对象浏览器。 有关详细信息，请参阅查看代码的结构。

使用 -doc 进行编译以便将文档注释处理到文件中。

示例

此示例使用 <param> 标记来描述 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 注释标记