Создайте файл справки Sandcastle для веб-сайта без параметра «Файл XML-документации» - PullRequest
2 голосов
/ 19 сентября 2008

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

Вкладка «Построение» на страницах свойств содержит только параметры: «Начать действие», «Построить решение» и «Проверка доступности». У меня нет параметров вывода или файла документации XML, как в других моих проектах.

На сайте, с которым я работаю, нет фактического файла .proj, что может быть проблемой. Если это проблема, каков наилучший способ создать проект для проекта, который находится под контролем исходного кода и над которым работают многие люди с минимальными нарушениями?

Используется Visual Studio 2005 Professional.

Ответы [ 2 ]

1 голос
/ 19 сентября 2008

Проблема с веб-сайтами в VS2k5 заключается в том, что при компиляции получаемые в результате dll становятся беспорядочными. Нет пространств имен, странных имен и т. Д.

Если вы действительно хотите создать файл справки Sandcastle, обратите внимание на преобразование своего веб-сайта в веб-приложение. Вы можете определенно генерировать документы исходного кода для этого.

0 голосов
/ 08 марта 2011

Я еще не пробовал, но вы можете попробовать следующее Документирование веб-сайтов / проектов с сайта Эрика Вудраффа. Это дает конкретику о том, как это можно сделать.

Обновление: я попробовал, и это работает для обычных веб-сайтов. Единственная проблема, которую я вижу, это что у веб-сайтов нет пространств имен. Поэтому, когда я запускаю его, я получаю тему от FolderName_WebPage Формат класса без какой-либо логической группировки. Так что это alhpabetical по имя папки и страницы. Создав контент, вы можете отредактировать файл справки, используя помогите компилятору / сборщику и сгруппируйте темы по мере необходимости.

...