Поделиться через

<returns> (Visual Basic)

  • Статья

Задает возвращаемое значение свойства или функции.

<returns>description</returns>

Параметры

  • description
    Описание возвращаемого значения.

Заметки

Тег <returns> используется в комментарии в объявлении метода для описания возвращаемого значения.

Чтобы выделить документирующие комментарии в отдельный файл, необходимо использовать при компиляции параметр /doc.

Пример

В этом примере тег <returns> используется, чтобы объяснить, что возвращает функция DoesRecordExist.

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