<summary>

  • Article

La balise <summary> doit être utilisée pour décrire un type ou un membre de type. Permet <remarks> d’ajouter des informations supplémentaires à une description de type.

Syntaxe

/// <summary>description</summary>

Paramètres

description
Résumé de l’objet.

Notes

Le texte de la <summary> balise est la seule source d’informations sur le type dans IntelliSense, et s’affiche également dans l’Explorateur d’objets et dans le rapport web de commentaire de code.

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

Exemple

// xml_summary_tag.cpp
// compile with: /LD /clr /doc
// post-build command: xdcmake xml_summary_tag.dll

/// Text for class MyClass.
public ref class MyClass {
public:
   /// <summary>MyMethod is a method in the MyClass class.
   /// <para>Here's how you could make a second paragraph in a description. <see cref="System::Console::WriteLine"/> for information about output statements.</para>
   /// <seealso cref="MyClass::MyMethod2"/>
   /// </summary>
   void MyMethod(int Int1) {}

   /// text
   void MyMethod2() {}
};

Voir aussi

Documentation XML