.NET XML 문서 설명에는 도움말 파일에 추가되지 않은 Sandcastle의 지시문이 포함됩니다.

Question

흥미로운 것을 가지고 있습니다.C #에서 XML 문서 주석을 사용하여 메소드를 문서화하고 있습니다.참조 된 파일의 모든 내용을 포함하도록 지시문을 사용하고 싶습니다.XML 문서로 형식화 된 문자열을받는 코드를 문서화하고 매개 변수 설명서에 xsd 파일을 포함 시키려고합니다.

Visual Studio에서 생성 한 XML이 기대하는 것처럼 이렇게 잘 작동합니다.다음은 XML의 스 니펫이 있습니다.

    /// <param name="xml">XML string - see Test.xsd <include file="XSD/Test.xsd" path="/*"/> After file include</param>

.

그러나 SandCastle을 사용하여 도움말 파일을 생성하면 XSD 파일의 내용이 표시되지 않지만 Sandcastle은 오류를보고하지 않습니다.파일 이름을 사용하여 도움말 파일이있는 위치와 상대로 파일 이름을 사용하려고했습니다.

그러나 Visual Studio는 파일을 찾을 수 없습니다.두 위치 모두에 넣고 여전히 포함 된 파일이 나타나지 않습니다.

아이디어가 있습니까?

Answer 1

The include tag is processed at compiler time, so the generated XML file should contain all of its referred contents. Hence you have to put your XSD folder relative to the C# source file, then the compiler won't show any errors. After this, Sandcastle will be able to create the help file from the single XML document.