<returns> (Visual C++)

 

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

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

<returns>description</returns>  

Parameters

description
A description of the return value.

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

// 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; }  
};  

XML Documentation

Show: