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


<returns> тег документации

Тег <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-документация