定義參數名稱和描述。
語法
<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