XML 파일에 대해 문서 주석을 처리합니다.
문법
-doc[+ | -]
또는
-doc:file
주장들
| 기간 | 정의 |
|---|---|
+ | - |
선택 사항입니다. +또는 그냥 -doc지정하면 컴파일러가 설명서 정보를 생성하고 XML 파일에 배치합니다. 지정은 - 지정 -doc하지 않는 것과 같으므로 문서 정보를 만들지 않습니다. |
file |
사용되는 경우 -doc: 필수입니다. 컴파일의 소스 코드 파일의 주석으로 채워진 출력 XML 파일을 지정합니다. 파일 이름에 공백이 있는 경우 이름을 따옴표(" ")로 묶습니다. |
비고
이 -doc 옵션은 컴파일러가 설명서 주석이 포함된 XML 파일을 생성하는지 여부를 제어합니다. 구문을 사용하는 -doc:file 경우 매개 변수는 file XML 파일의 이름을 지정합니다. 사용 -doc 하거나 -doc+사용하는 경우 컴파일러는 컴파일러가 만드는 실행 파일 또는 라이브러리에서 XML 파일 이름을 가져옵니다. 옵션을 사용 -doc- 하거나 지정 -doc 하지 않으면 컴파일러가 XML 파일을 만들지 않습니다.
소스 코드 파일에서 설명서 주석은 다음 정의보다 우선할 수 있습니다.
생성된 XML 파일을 Visual Studio IntelliSense 기능과 함께 사용하려면 XML 파일의 파일 이름이 지원하려는 어셈블리와 같게 합니다. 어셈블리가 Visual Studio 프로젝트에서 참조될 때 .xml 파일도 찾을 수 있도록 XML 파일이 어셈블리와 동일한 디렉터리에 있는지 확인합니다. IntelliSense가 프로젝트 내 또는 프로젝트에서 참조하는 프로젝트 내에서 코드를 사용하기 위해서는 XML 문서 파일이 필요하지 않습니다.
컴파일 -target:module하지 않는 한 XML 파일에는 태그가 포함됩니다 <assembly></assembly>. 이러한 태그는 컴파일의 출력 파일에 대한 어셈블리 매니페스트를 포함하는 파일의 이름을 지정합니다.
코드의 주석에서 설명서를 생성하는 방법은 XML 주석 태그 를 참조하세요.
| Visual Studio 통합 개발 환경에서 -doc 설정하려면 |
|---|
| 1. 솔루션 탐색기에서 프로젝트를 선택해야 합니다.
프로젝트 메뉴에서 속성을 클릭합니다. 2. 컴파일 탭을 클릭합니다. 3. XML 문서 생성 파일 상자에서 값을 설정합니다. |
예시
샘플은 XML을 사용하여 코드 문서화 를 참조하세요.
참고하십시오
- Visual Basic Command-Line 컴파일러
- XML을 사용하여 코드 문서화
.NET