Sdílet prostřednictvím

<remarks> značka dokumentace

  • Článek

Značka <remarks> se používá k přidání informací o typu, doplnění informací zadaných <summary>pomocí . Tyto informace se zobrazí v prohlížeči objektů a ve webové sestavě komentáře kódu.

Syntaxe

/// <remarks>description</remarks>

Parametry

description
Popis člena.

Poznámky

Zkompilujte je /doc pro zpracování komentářů dokumentace k souboru.

Příklad

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

Viz také

Dokumentace XML