<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 註解標籤