[개발] C# 프로그래머 참조 - 문서 주석에 대한 권장 태그 <summary>

C# 프로그래머 참조

<summary>

<summary>description</summary>

다음은 각 문자에 대한 설명입니다.

description

개체에 대한 요약입니다.

설명

형식 또는 형식 멤버를 설명하려면 <summary> 태그를 사용해야 합니다. 형식에 대한 설명을 보충하는 정보를 추가하려면 <remarks>를 사용합니다.

<summary> 태그의 텍스트는 IntelliSense에서 형식에 대해 표시할 정보를 가져오는 유일한 출처이며, 이 텍스트는 개체 브라우저와 코드 주석 웹 보고서에도 표시됩니다.

/doc로 컴파일하여 문서 주석을 파일로 저장합니다.

예제

// xml_summary_tag.cs
// compile with: /doc:xml_summary_tag.xml

/// text for class MyClass
public class MyClass
{
   /// <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.Main"/>
   /// </summary>
   public static void MyMethod(int Int1)
   {
   }

   /// text for Main
   public static void Main ()
   {
   }
}

참고 항목

문서 주석에 대한 권장 태그