<remarks> Dokumentationstag

  • Artikel

Das Tag <remarks> wird verwendet, um Informationen zu einem Typ hinzuzufügen. Dadurch werden die mit <summary> angegebenen Informationen ergänzt. Diese Informationen werden im Objektkatalog und im Webbericht über Codekommentare angezeigt.

Syntax

/// <remarks>description</remarks>

Parameter

description
Eine Beschreibung des Members

Hinweise

Kompilieren sie, /doc um Dokumentationskommentare in einer Datei zu verarbeiten.

Beispiel

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

Siehe auch

XML-Dokumentation