Sandcastle не документирует ни один библиотечный проект в Visual Studio - PullRequest
Новая
       39

Sandcastle не документирует ни один библиотечный проект в Visual Studio

0 голосов
/ 01 декабря 2018

Я новичок в Сандкасле.Я использую версию 2018.7.8.0.У меня есть решение в Visual Studio 2015, в котором есть 2 проекта, один из которых - библиотека классов (в Sandcastle есть файлы XMl и dll), а другой - обычное консольное приложение C #, в котором есть XMl и exe-файлы в sandcastle).

При создании проекта в Sandcastle или Visual Studio я получаю только проект библиотеки классов, задокументированный в файле index.html.

Есть ли способ включить другой проект?

1 Ответ

0 голосов
/ 14 мая 2019

Вы знаете - комментарии XML должны быть добавлены в ваш код для документирования различных типов и их членов.

Кроме того, вы должны включить вывод файла комментариев XML для проекта.

  1. В обозревателе решений щелкните правой кнопкой мыши проект и выберите Свойства.
  2. Выберите страницу свойств сборки.
  3. В разделе «Вывод» установите флажок «Далее».в текстовое поле файла документации Xml и укажите имя для файла XML.Хотя это и не обязательно, общепринятым условием является присвоение имени файлу комментариев XML после связанной сборки (кроме случаев с расширением .xml).Имя сборки можно найти на странице свойств приложения.
  4. Если у вас есть решение с несколькими проектами , которое необходимо документировать, повторите описанные выше шаги для каждого проекта в решении.Рекомендуется дать каждому файлу XML-комментариев каждого проекта уникальное имя.

Для использования Sandcastle вы найдете пошаговое руководство Создание первого проекта .

...