<returns> (C#)

Switch View :
ScriptFree
C# Programmer's Reference
<returns>
<returns>description</returns>

where:

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

// xml_returns_tag.cs
// compile with: /doc:xml_returns_tag.xml 

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

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

See Also

Recommended Tags for Documentation Comments