Partilhar via


Marca de documentação <returns>

A marca <returns> deve ser usada no comentário para uma declaração de método descrever o valor retornado.

Sintaxe

/// <returns>description</returns>

Parâmetros

description
Uma descrição do valor retornado.

Comentários

Compile com /doc para processar comentários de documentação em um arquivo.

Exemplo

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

Confira também

Documentação XML