XML-документация .net Комментарий включает директиву sandcastle, не добавляемую в файл справки - PullRequest
Новая
       40

XML-документация .net Комментарий включает директиву sandcastle, не добавляемую в файл справки

0 голосов
/ 01 марта 2012

Есть интересный.Я документирую метод, используя комментарии документации 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 не сообщает об ошибках.Я пытался использовать имя файла относительно того, где находятся файлы справки, то есть

, но тогда Visual Studio жалуется, что не может найти файл.Я поставил их в обоих местах, и все еще включенный файл не появляется.

Есть идеи?

1 Ответ

0 голосов
/ 02 марта 2012

Тег include обрабатывается во время компиляции, поэтому сгенерированный XML-файл должен содержать все упомянутое содержимое.Следовательно, вы должны поместить свою папку XSD относительно исходного файла C #, тогда компилятор не будет показывать никаких ошибок.После этого Sandcastle сможет создать файл справки из одного XML-документа.

...