문서 주석에 대한 권장 태그(C# 프로그래밍 가이드)

  • 아티클

업데이트: 2007년 11월

C# 컴파일러는 코드의 문서 주석을 XML 파일로 만듭니다. XML 파일을 처리하여 문서를 만드는 작업은 사용자의 사이트에서 구현해야 하는 세부적인 사항입니다.

태그는 형식, 형식 멤버 등과 같은 코드 구문에서 처리됩니다.

참고:

문서 주석은 네임스페이스에 적용할 수 없습니다.

컴파일러는 유효한 XML 태그를 모두 처리합니다. 아래 태그에는 사용자 문서에서 일반적으로 사용하는 기능이 포함되어 있습니다.

태그

<c>

<para>

<see>*

<code>

<param>*

<seealso>*

<example>

<paramref>

<summary>

<exception>*

<permission>*

<typeparam>*

<include>*

<remarks>

<typeparamref>

<list>

<returns>

<value>

* 표시는 컴파일러가 구문을 확인함을 나타냅니다.

문서 주석의 텍스트에 꺾쇠괄호를 사용하려면 &lt; 및 &gt;를 사용합니다. 예를 들어, &lt;꺾쇠괄호 안의 텍스트&gt; 같은 형식입니다.

참고 항목

작업

XML 문서 샘플

개념

C# 프로그래밍 가이드

참조

/doc (문서 주석 처리) (C# 컴파일러 옵션)

XML 문서 주석(C# 프로그래밍 가이드)