<returns> (C# Programming Guide)

 

Updated: July 20, 2015

For the latest documentation on Visual Studio 2017 RC, see Visual Studio 2017 RC Documentation.

<returns>description</returns>  

Parameters

description
A description of the return value.

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.

    // 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()
        {
        }
    }

C# Programming Guide
Recommended Tags for Documentation Comments

Show: