<summary> (Visual C++)
La balise <summary> doit être utilisée pour décrire un type ou un membre d'un type.Utilisez <remarks> pour ajouter des informations complémentaires à une description de type.
<summary>description</summary>
Paramètres
- description
Résumé de l'objet.
Notes
Le texte de la balise d' <summary> est la seule source d'informations sur le type dans Intellisense, et est également affiché dans Explorateur d'objets et dans le rapport Web de commentaires du code.
Compilez avec /doc pour traiter les commentaires de documentation et les placer 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() {}
};