다음을 통해 공유


<summary>

<summary> 태그를 사용하여 형식 또는 형식 멤버를 설명해야 합니다. <remarks>를 사용하여 형식 설명에 보충 정보를 추가할 수 있습니다.

구문

/// <summary>description</summary>

매개 변수

description
개체에 대한 요약입니다.

설명

태그의 <summary> 텍스트는 IntelliSense의 형식에 대한 유일한 정보 원본이며 개체 브라우저 및 코드 주석 웹 보고서에도 표시됩니다.

/doc 파일에 대한 설명서 주석을 처리하기 위해 컴파일합니다.

예시

// xml_summary_tag.cpp
// compile with: /LD /clr /doc
// post-build command: xdcmake xml_summary_tag.dll

/// Text for class MyClass.
public ref class MyClass {
public:
   /// <summary>MyMethod is a method in the MyClass class.
   /// <para>Here's how you could make a second paragraph in a description. <see cref="System::Console::WriteLine"/> for information about output statements.</para>
   /// <seealso cref="MyClass::MyMethod2"/>
   /// </summary>
   void MyMethod(int Int1) {}

   /// text
   void MyMethod2() {}
};

참고 항목

XML 설명서