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

Question

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

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

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

Это использование Visual Studio 2005 Professional.

Answer 1

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

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

Answer 2

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

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