<retorns> (Visual Basic)
Especifica o valor de retorno da propriedade ou função.
<returns>description</returns>
Parâmetros
- description
Uma descrição de valor de retorno.
Comentários
Use a marca <returns> no comentário de uma declaração de método para descrever o valor de retorno.
Compile com /doc para processar os comentários de documentação para um arquivo.
Exemplo
Este exemplo usa a marca <returns> para explicar o que a função DoesRecordExist retorna.
''' <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
Consulte também
Referência
Recomendado marcas XML para comentários da documentação (Visual Basic)