Создание файла справки Sandcastle для веб-сайта без опции " Xml Documentation File
Я пытаюсь создать файл справки Sandcastle для веб-сайта. В окне свойств проекта нет никаких параметров для создания XML-файла документации, необходимого для Sandcastle.
Вкладка построение на страницах свойств содержит только параметры: действие запуска, действие построения решения и проверка специальных возможностей. У меня нет никаких опций для вывода или XML-файла документации, как у других моих проектов.
Веб-сайт, с которым я работаю, не имеет фактического .proj файл, который может быть проблемой. Если это проблема,то как лучше всего создать ее для проекта, который находится под управлением исходного кода и над которым работают многие люди с минимальными нарушениями?
Используется Visual Studio 2005 professional.
2 ответа:
Проблема с веб-сайтами в VS2k5 заключается в том, что, когда они компилируются, результирующие библиотеки DLL-это беспорядок. Никаких пространств имен, странных имен и т. д.
Если вы действительно хотите создать файл справки Sandcastle, посмотрите на преобразование вашего веб-сайта в веб-приложение. Вы определенно можете создавать документы с исходным кодом для этого.
Я еще не пробовал, но вы можете попробовать следующее документирование веб-сайтов / проектов с сайта Эрика Вудраффа. Он дает конкретные указания о том, как это можно сделать.
Обновление: я пробовал, и это работает для обычных веб-сайтов. Единственная проблема, которую я вижу, это что веб-сайты не имеют пространств имен. Поэтому, когда я запускаю его, я получаю тему Формат класса FolderName_WebPage без какой-либо логической группировки. Так что это alhpabetic by имя папки и страницы. Как только вы получили созданное содержимое можно редактировать в файле справки с помощью helpcompiler / builder и сгруппируйте темы по мере необходимости.