<include> 설명서 태그
<include> 태그를 사용하면 소스 코드의 형식과 멤버를 설명하는 다른 파일의 주석을 참조할 수 있습니다. 이 태그는 소스 코드 파일에 직접 설명서 주석을 배치하는 대신 사용할 수 있습니다. 예를 들어 팀 또는 회사 전체에서 사용되는 표준 "상용구" 주석을 삽입하는 데 사용할 <include> 수 있습니다.
구문
/// <include file='filename' path='tag-path[@name="ID"' />
매개 변수
filename
문서가 포함된 파일의 이름입니다. 경로를 사용하여 파일 이름을 정규화할 수 있습니다. 이름을 단일 또는 이중 따옴표로 묶습니다. 컴파일러가 찾을 filename수 없는 경우 경고를 실행합니다.
tag-path
파일에 포함된 원하는 노드 집합을 선택하는 유효한 XPath 식입니다.
name
주석 앞에 오는 태그의 이름 지정자입니다. name에는 ID가 있습니다.
ID
주석 앞에 오는 태그의 ID입니다. ID를 작은따옴표나 큰따옴표로 묶습니다.
설명
<include> 태그는 XML XPath 구문을 사용합니다. 를 사용하여 <include>사용자 지정하는 방법은 XPath 설명서를 참조하세요.
/doc 파일에 대한 설명서 주석을 처리하기 위해 컴파일합니다.
예시
이 예제에서는 여러 파일을 사용합니다. 사용하는 <include>첫 번째 파일에는 다음 설명서 주석이 포함됩니다.
// xml_include_tag.cpp
// compile with: /clr /doc /LD
// post-build command: xdcmake xml_include_tag.dll
/// <include file='xml_include_tag.doc' path='MyDocs/MyMembers[@name="test"]/*' />
public ref class Test {
void TestMethod() {
}
};
/// <include file='xml_include_tag.doc' path='MyDocs/MyMembers[@name="test2"]/*' />
public ref class Test2 {
void Test() {
}
};
두 번째 파일은 xml_include_tag.doc다음 설명서 주석을 포함합니다.
<MyDocs>
<MyMembers name="test">
<summary>
The summary for this type.
</summary>
</MyMembers>
<MyMembers name="test2">
<summary>
The summary for this other type.
</summary>
</MyMembers>
</MyDocs>
프로그램 출력
<?xml version="1.0"?>
<doc>
<assembly>
<name>t2</name>
</assembly>
<members>
<member name="T:Test">
<summary>
The summary for this type.
</summary>
</member>
<member name="T:Test2">
<summary>
The summary for this other type.
</summary>
</member>
</members>
</doc>