| title |
<returns> (Visual C++) | Microsoft Docs |
| ms.custom |
|
| ms.date |
11/04/2016 |
| ms.reviewer |
|
| ms.suite |
|
| ms.technology |
|
| ms.tgt_pltfrm |
|
| ms.topic |
article |
| f1_keywords |
|
| dev_langs |
|
| helpviewer_keywords |
returns C++ XML tag |
<returns> C++ XML tag |
|
| ms.assetid |
5e3b0ed9-838d-4953-a93e-76d2d0a19fb9 |
| caps.latest.revision |
8 |
| author |
mikeblome |
| ms.author |
mblome |
| manager |
ghogen |
The <returns> tag should be used in the comment for a method declaration to describe the return value.
<returns>description</returns>
description
A description of the return value.
Remarks
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