Документация по коду для приложения ASP.NET + VB.NET - PullRequest
1 голос
/ 21 июля 2009

У нас есть очень старое приложение, относящееся к эпохе ASP, которое мы постепенно реорганизуем в кодовую базу ASP.NET + VB.NET.

Содержит множество файлов следующих типов:

aspx, asmx, ascx, vb, js (JavaScript), html, vbs (VBScript).

Бэкэнд-база данных - SQL Server 2005 с большим количеством sprocs.

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

Большое спасибо.

Ажит.

Ответы [ 3 ]

2 голосов
/ 21 июля 2009

Вы можете взглянуть на инструмент Microsoft Sandcastle . Я использовал его много раз, и он генерирует документацию на основе комментариев, представленных в вашем. Если я правильно помню, он также может генерировать документацию для библиотек JavaScript.

0 голосов
/ 21 июля 2009

Я использовал SandCastle , и он работает слишком хорошо, если в вашем коде есть xml-комментарии.

Сначала включите XML-документацию в своем проекте, установив ее в «Свойства проекта» -> «Компиляция» -> «Создать документацию XML».

После того, как вы это сделаете, вам, возможно, придется установить обработку предупреждений как ошибок, чтобы студия могла указать вам, где и все XML-комментарии отсутствуют.

Чтобы добавить комментарий XML, поместите курсор перед определением класса или определения функции и введите

///

Это автоматически сгенерирует теги xml для документации, а затем, как только вы закончите, вы можете импортировать проект и начать создавать документацию.

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

Дайте мне знать, если у вас возникнут какие-либо другие проблемы.

Мое последнее предложение: создайте проект hello world, запишите его в xml и привыкните к нему с песком.

0 голосов
/ 21 июля 2009

Есть некоторые из них:

SandCastle

NDoc

...