https://msdn.microsoft.com/ko-kr/windows/apps/b2s063f7
XML 문서 주석(C# 프로그래밍 가이드)
Visual C#에서는 주석이 참조하는 코드 블록 바로 앞의 소스 코드의 특별 주석 필드(세 개의 슬래시로 표시)에 XML 요소를 포함하여 코드에 대한 문서를 만들 수 있습니다. 예를 들면 다음과 같습니다.
/// <summary>
/// This class performs an important function.
/// </summary>
public class MyClass{}
/doc 옵션을 사용하여 컴파일하는 경우 컴파일러는 소스 코드에서 모든 XML 태그를 검색하고 XML 문서 파일을 만듭니다. 컴파일러에서 생성한 파일을 기반으로 최종 문서를 만들려면 사용자 지정 도구를 만들거나 Sandcastle과 같은 도구를 사용하면 됩니다.
XML 요소를 참조하려면(예를 들어, 함수가 XML 문서 주석에서 설명하려는 특정 XML 요소를 처리하는 경우) 표준 인용 메커니즘(<및>)을 사용할 수 있습니다. 코드 참조(cref) 요소에서 제네릭 식별자를 참조하려면 이스케이프 문자(예: cref=”List<T>”) 또는 괄호(cref=”List{T}”)를 사용할 수 있습니다. 특별한 경우로, 컴파일러는 제네릭 식별자를 참조할 때 문서 주석을 더 쉽게 작성할 수 있도록 괄호를 꺾쇠 괄호로 구문 분석합니다.
참고 |
---|
XML 문서 주석은 메타데이터가 아닙니다. 이러한 주석은 컴파일된 어셈블리에 포함되지 않으므로 리플렉션을 통해 액세스할 수 없습니다. |
반응형
'프로그래밍(Programming) > C#' 카테고리의 다른 글
GetHashCode() (0) | 2015.11.11 |
---|---|
C# Linq 1강 - Linq 맛보기 (0) | 2015.09.10 |
[C#] 해시테이블 vs 딕셔너리 ( hashtable vs. dictionary ) | (0) | 2015.09.02 |
C# queue (0) | 2015.09.02 |
c# Stack (0) | 2015.09.02 |