< > megjegyzések (Visual Basic)

A tag megjegyzési szakaszát adja meg.

Szemantika

<remarks>description</remarks>  

Paraméterek

description
A tag leírása.

Megjegyzések

A címkével <remarks> információkat adhat meg egy típusról, kiegészítve az összegzéssel<> megadott információkat.

Ezek az információk megjelennek az Objektumböngészőben. Az Object Browserről további információt a Kód szerkezetének megtekintése című témakörben talál.

Fordítás -doc használatával egy fájl dokumentációs megjegyzéseinek feldolgozásához.

példa

Ez a példa a <remarks> címke használatával magyarázza el, hogy mi a UpdateRecord módszer.

''' <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

Lásd még

• XML-megjegyzéscímkék