.NET XML Документация Комментарий включает директиву в Sandcastle, не добавляя, чтобы помочь файлу

Question

есть интересный.Я документирую метод с использованием комментариев документации XML в C #.Я хочу использовать директиву, чтобы включить все содержимое ссылочного файла.Я документирую кусок кода, который принимает строку, отформатированную в качестве XML-документа, и я хочу включить файл XSD в документацию параметров.

Это работает нормально в том, что XML, сгенерированный Visual Studio, так как я ожидаю.Вот фрагмент XML:

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

.

Однако, когда я использую SandcaStle, чтобы сгенерировать файл справки из этого, содержимое файла XSD не отображается, но Sandcastle не сообщает о каких-либо ошибках.Я пытался использовать имя файла относительно того, где также есть файлы справки, то есть I.E.

.

Но затем 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.