Всем привет! Мне понадобилось сгенерировать документацию к коду в VS2005, но кроме как XML файл я из студии так и не смог ничего выжать. Можно ли получить хотя бы HTML (я уж не говорю про *.chm)? Может я и ошибаюсь, но в VS2003 такая возможность вроде была...

З.Ы. Покапался в MSDN - там послали на страничку с каким-то сторонним софтом, который документирование сборок под FrameWork 2.0, как оказалось, не поддерживает. Я в тупике.

Это сообщение отредактировал(а) #Sage - 16.1.2006, 21:55

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

Пасиба большое. А то я уж нервничать начинал :). А не подскажешь где можно взять прогу для доков?

#Sage
Например, Doxygen.

лучше - NDoc
кстати, студия умеет сама генерить документацию из xml-файлов!

Да, NDoc скачал. Про него собственно и говориться в MSDN.


Ага, значит мне всё-таки не показалось, что студия всё могла сама. Не подскажешь как это сделать в VS2005?

С удивлением обнаружил отсутствие команды типа "Preview HTML documentation" в 2005-й студии
Точно знаю, что в 2003-й она есть

Держите методу "Документирование в формате XML", которую я составил из статей MSDN. Как создавать документацию в виде html страниц из документированного кода -- в самом ее конце. Успехов.

Присоединённый файл ( Кол-во скачиваний: 7 )
 XML_Documentation.rar 47,08 Kb

Cr@$h, спасибо за статью, но в 2005-й студии нет такой команды как "Build comment web pages".

Быть может просто убрали эту фичу...
Или она реализована в другом месте. Странно, последний MSDN по какой студии вообще? Там это написано. Говорю так, потому что 2005 еще не юзал нормально. Но по xml-комментариям файл точно генериться должен -- если не по дефолту, то в свойствах проекта должно быть место, где указываешь имя такого создаваемого файла.

Cr@sh, я тоже так рассуждал. Но в MSDN описыватся только создание документации в xml. Как силами самой среды сделать HTML файл там не рассказывается... Ладно, мы не гордые, воспользуюсь сторонним софтом. Просто если кто найдёт в студии возможность создания HTML напишите pls.
P.S> Это я про VS2005

Ох уж эти... Убрали почему-то, я думаю. Наверное, многим не понравилось шаблонность и ненастраиваемость этих страниц, а дорабатывать это им было в лом. Если что, в MSDN надо искать статьи типа:

• Creating Code Reports
• Code Comment Web Report
• Adding Comments in C# Code
• Viewing Code Structure with Comments
• Build Comment Web Pages Dialog Box

и при этом они должны касаться VS 2005.

В паре мест в MSDN упоминается о том, что на разработчика справки ложится обязанность по созданию XSLT-преобразования из XML в HTML. По ходу, в 2003-й студии скорее всего просто был зашит готовый XSL-файл, выводящий preview. А вообще, NDoc рулит, и никакая студия его не переплюнет по возможностям.