<returns> (C# Programming Guide)

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

See Also

Reference

Recommended Tags for Documentation Comments (C# Programming Guide)

Concepts

C# Programming Guide