共用方式為

<remarks> (Visual Basic)

  • 發行項

指定成員的備註區段。

<remarks>description</remarks>

參數

  • description
    為成員的描述。

備註

使用 <remarks> 標記 (Tag) 可加入型別的相關資訊，補充以 <summary> (Visual Basic) 指定的資訊。

這項資訊會出現在物件瀏覽器。 如需物件瀏覽器的詳細資訊，請參閱 檢視程式碼的結構。

使用 /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 標記 (Visual Basic)