returns

This element is used to describe the return value of a method.

Syntax

This top-level element is valid on all methods that return a value. The description will appear in the Object Browser.

<returns>description</returns>

<returns>description</returns>

Examples

C++

Copy to Clipboard Print

/// <summary> 
/// The <c>Increment</c> method increments the stored number by one 
/// </summary> 
/// <returns>The new sample number after being incremented</returns> 
/// <conceptualLink target="d0db2290-08bb-40cc-9797-23a342b96564" /> 
/// <conceptualLink target="fa97c10b-a683-4d10-a01c-5787dbdd42d3" /> 
public int Increment()
{
    return ++this.SampleNumber;
}

/// <summary> 
/// The <c>Increment</c> method increments the stored number by one 
/// </summary> 
/// <returns>The new sample number after being incremented</returns> 
/// <conceptualLink target="d0db2290-08bb-40cc-9797-23a342b96564" /> 
/// <conceptualLink target="fa97c10b-a683-4d10-a01c-5787dbdd42d3" /> 
public int Increment()
{
    return ++this.SampleNumber;
}

Reference

Increment

Other Resources

Section Elements