-doc

  • 아티클

XML 파일에 대해 문서 주석을 처리합니다.

구문

-doc[+ | -]

또는

-doc:file

인수

용어 정의
+ | - 선택 사항. + 또는 -doc만 지정하면 컴파일러가 문서 정보를 생성하여 XML 파일에 넣습니다. -를 지정하면 -doc를 지정하지 않는 것과 같으며, 문서 정보를 생성하지 않게 합니다.
file -doc:를 사용하는 경우 필수입니다. 출력 XML 파일을 지정하며, 이 파일은 컴파일의 소스 코드 파일에 있는 주석으로 채워집니다. 파일 이름에 공백이 있으면 이름을 따옴표(“ ”)로 묶습니다.

설명

-doc 옵션은 컴파일러가 문서 주석을 포함하는 XML 파일을 생성하는지 여부를 제어합니다. -doc:file 구문을 사용하는 경우 file 매개 변수에서 XML 파일 이름을 지정합니다. -doc 또는 -doc+를 사용하는 경우 컴파일러는 컴파일러가 생성하는 실행 파일 또는 라이브러리에서 XML 파일 이름을 가져옵니다. -doc-를 사용하거나 -doc 옵션을 지정하지 않는 경우 컴파일러는 XML 파일을 생성하지 않습니다.

소스 코드 파일에서 문서 주석은 다음 정의보다 앞에 올 수 있습니다.

Visual Studio IntelliSense 기능에서 생성된 XML 파일을 사용하려면 XML 파일의 파일 이름을 지원하려는 어셈블리와 동일하게 지정할 수 있습니다. 어셈블리가 Visual Studio 프로젝트에서 참조되면 .xml 파일도 검색되도록 XML 파일이 어셈블리와 동일한 디렉터리에 있는지 확인합니다. IntelliSense에서 프로젝트 내의 코드나 프로젝트에서 참조하는 프로젝트 내의 코드를 작업하는 데는 XML 문서 파일이 필요하지 않습니다.

-target:module로 컴파일하는 경우 외에는 XML 파일에 <assembly></assembly> 태그가 포함됩니다. 이러한 태그는 컴파일 출력 파일의 어셈블리 매니페스트를 포함하는 파일의 이름을 지정합니다.

코드의 주석에서 문서를 생성하는 방법은 XML Comment Tags(XML 주석 태그)를 참조하세요.

Visual Studio 통합 개발 환경에서 -doc를 설정하려면
1. 솔루션 탐색기에서 프로젝트를 선택합니다. 프로젝트 메뉴에서 속성을 클릭합니다.
2. 컴파일 탭을 클릭합니다.
3. XML 문서 파일 생성 상자에 값을 설정합니다.

예시

샘플은 Documenting Your Code with XML(XML과 함께 코드 문서화)을 참조하세요.

참고 항목