指定成員的備註區段。
語法
<remarks>description</remarks>
參數
description
成員的描述。
備註
<remarks>使用標記來新增類型的相關信息,以摘要>補充指定的<資訊。
此資訊會出現在物件瀏覽器中。 如需物件瀏覽器的相關信息,請參閱 檢視程式代碼的結構。
使用 -doc 編譯以處理檔案的檔批注。
範例
此範例會 <remarks> 使用標記來說明 UpdateRecord 方法的用途。
''' <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