Share via


<returns> (Visual C++)

 

The new home for Visual Studio documentation is Visual Studio 2017 Documentation on docs.microsoft.com.

The latest version of this topic can be found at <returns> (Visual C++).

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

Syntax

<returns>description</returns>  

Parameters

description
A description of the return value.

Remarks

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

Example

// xml_returns_tag.cpp  
// compile with: /LD /clr /doc  
// post-build command: xdcmake xml_returns_tag.dll  
  
/// Text for class MyClass.  
public ref class MyClass {  
public:  
   /// <returns>Returns zero.</returns>  
   int GetZero() { return 0; }  
};  

See Also

XML Documentation