Skip to content

Latest commit

 

History

History
47 lines (34 loc) · 1.21 KB

File metadata and controls

47 lines (34 loc) · 1.21 KB
title <remarks> (Visual C++)
ms.date 11/04/2016
f1_keywords
remarks
<remarks>
helpviewer_keywords
<remarks> C++ XML tag
remarks C++ XML tag
ms.assetid c820083b-3192-40ab-9ec8-1472c55b4247

<remarks> (Visual C++)

The <remarks> tag is used to add information about a type, supplementing the information specified with <summary>. This information is displayed in the Object Browser and in the Code Comment Web Report.

Syntax

<remarks>description</remarks>

Parameters

description
A description of the member.

Remarks

Compile with /doc to process documentation comments to a file.

Example

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

See Also

XML Documentation