Share via

<returns> balise de documentation

  • Article

La balise <returns> doit être utilisée dans le commentaire relatif à une déclaration de méthode pour décrire la valeur renvoyée.

Syntaxe

/// <returns>description</returns>

Paramètres

description
Description de la valeur de retour.

Notes

Compilez avec /doc pour traiter les commentaires de documentation dans un fichier.

Exemple

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

Voir aussi

Documentation XML