Skip to content

Latest commit

 

History

History
54 lines (45 loc) · 1.51 KB

File metadata and controls

54 lines (45 loc) · 1.51 KB
title <remarks> (Visual C++) | Microsoft Docs
ms.custom
ms.date 11/04/2016
ms.reviewer
ms.suite
ms.technology
cpp-ide
ms.tgt_pltfrm
ms.topic article
f1_keywords
remarks
<remarks>
dev_langs
C++
helpviewer_keywords
<remarks> C++ XML tag
remarks C++ XML tag
ms.assetid c820083b-3192-40ab-9ec8-1472c55b4247
caps.latest.revision 9
author mikeblome
ms.author mblome
manager ghogen

<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