Udostępnij za pośrednictwem


<remarks> tag dokumentacji

Tag służy do dodawania <remarks> informacji o typie, uzupełniając informacje określone za pomocą <summary>polecenia . Te informacje są wyświetlane w przeglądarce obiektów i w raporcie sieci Web komentarza kodu.

Składnia

/// <remarks>description</remarks>

Parametry

description
Opis elementu członkowskiego.

Uwagi

Skompiluj element , /doc aby przetworzyć komentarze dokumentacji do pliku.

Przykład

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

Zobacz też

Dokumentacja XML