Describes the return value. This is a top-level tag.

Syntax

<returns>description<returns>

This tag is used in a method and function comment when they return some value. Use <value> tag for properties.

Examples

Visual Basic

Copy CodeCopy Code

''' <summary>Our sample method.</summary>

''' <returns>True if no error occurs.</returns>

Function method1(ByVal x As Integer) As Boolean

C#

Copy CodeCopy Code

/// <summary>Our sample method.</summary>

/// <returns>True if no error occurs.</returns>

public bool method1(int x)

 

The sections in bold are added automatically when using Add XML Comment from pop-up menu.

See Also

XML Comments