0 out of 1 rated this helpful - Rate this topic

<returns> (C# Programming Guide)

Visual Studio 2012

Visual Studio 2010
Visual Studio 2008
Visual Studio 2005
Visual Studio .NET 2003

<returns>description</returns>

Parameters

description: A description of the return value.

Remarks

The <returns> tag should be used in the comment for a method declaration to describe the return value.

Compile with /doc to process documentation comments to a file.

Example

// compile with: /doc:DocFileName.xml  

/// text for class TestClass 
public class TestClass
{
    /// <returns>Returns zero.</returns> 
    public static int GetZero()
    {
        return 0;
    }

    /// text for Main 
    static void Main()
    {
    }
}

Reference

Recommended Tags for Documentation Comments (C# Programming Guide)

Concepts

C# Programming Guide

Did you find this helpful? Yes No

Not accurate

Not enough depth

Need more code examples

(1500 characters remaining)