다음을 통해 공유

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

  • 아티클

C# 컴파일러는 코드에서 문서 주석을 처리하고 /doc 명령줄 옵션에 이름이 지정된 파일에서 문서 주석의 서식을 XML로 지정합니다. 컴파일러에서 생성 된 파일을 기반으로 최종 문서를 만들려면 사용자 지정 도구를 만들거나 같은 도구를 사용 하 여 Sandcastle.

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

참고

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

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

태그

<c>

<para>

<see>*

<code>

<param>*

<seealso>*

<example>

<paramref>

<summary>

<exception>*

<permission>*

<typeparam>*

<include>*

<remarks>

<typeparamref>

<list>

<returns>

<value>

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

문서 주석의 텍스트에 꺾쇠 괄호를 표시하려면 다음 예제에 표시된 대로 &lt;와 &gt;을 사용합니다.

/// <summary cref="C &lt; T &gt;">
/// </summary>

참고 항목

참조

/doc(C# 컴파일러 옵션)

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

개념

C# 프로그래밍 가이드