Поделиться через


<returns> (Visual C++)

Тег <returns> следует использовать в комментариях объявления метода для описания возвращаемого значения.

<returns>description</returns>

Параметры

  • description
    Описание возвращаемого значения.

Заметки

Чтобы обработать и сохранить комментарии документации в файл, при компиляции необходимо использовать параметр /doc.

Пример

// 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 (Visual C++)