Partager via


<remarks> balise de documentation

La <remarks> balise est utilisée pour ajouter des informations sur un type, en ajoutant les informations spécifiées avec <summary>. Ces informations sont affichées dans l’Explorateur d’objets et dans le rapport web de commentaire de code.

Syntaxe

/// <remarks>description</remarks>

Paramètres

description
Description du membre.

Notes

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

Exemple

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

using namespace System;

/// <summary>
/// You may have some primary information about this class.
/// </summary>
/// <remarks>
/// You may have some additional information about this class.
/// </remarks>
public ref class MyClass {};

Voir aussi

Documentation XML