Udostępnij za pośrednictwem

<> uwagi (Visual Basic)

  • Artykuł

Określa sekcję uwagi dla elementu członkowskiego.

Składnia

<remarks>description</remarks>

Parametry

description
Opis elementu członkowskiego.

Uwagi

Użyj tagu <remarks> , aby dodać informacje o typie, uzupełniając informacje określone za pomocą <podsumowania>.

Te informacje są wyświetlane w przeglądarce obiektów. Aby uzyskać informacje o przeglądarce obiektów, zobacz Wyświetlanie struktury kodu.

Skompiluj za pomocą -doc , aby przetworzyć komentarze dokumentacji do pliku.

Przykład

W tym przykładzie użyto tagu <remarks> , aby wyjaśnić, co UpdateRecord robi metoda.

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

Zobacz też