将单词的格式设置为参数。
语法
<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