<remarks> (Visual Basic)

指定成員的 remarks 區段。

語法

<remarks>description</remarks>  

參數

description
成員的描述。

備註

使用 <remarks> 標籤可新增類型的資訊，以補充使用 <summary> 所指定的資訊。

此資訊會出現在物件瀏覽器中。 如需物件瀏覽器的相關資訊，請參閱檢視程式碼結構 (機器翻譯)。

使用 -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

另請參閱

• XML 註解標籤