VBdocman это программа для автоматического создания технической документации из ваших визуальных базовых исходных файлов с помощью нескольких щелчков мыши. Он анализирует исходный код и автоматически создает таблицу содержимого, индекса, тем, перекрестных ссылок и чувствительной к контексту справки. Формат выходной документации полностью настраивается пользователем. Предопределенными форматами вывода являются:
Справка HTML (файл, который выглядит как MSDN)-
HTML-файлы (с индексом Java и таблицей содержимого)
WinHelp (файл К.Хлп)
Документ RTF
Xml
VBdocman работает как дополнение в MS Visual Basic 6.0. После вызова простого диалога через основное меню и (в простейшем случае) нажав одну кнопку, генерируется указанная документация вывода. Он автоматически создает все интересные ссылки, такие как Applies To, Методы, События, Свойства, События, Таблица содержимого и индекса. В больших проектах только эта работа экономит много дней скучной работы. Документация может быть отредактирована и дополнительное описание, данное там, такие как See Also, Примеры ссылки, объект, метод, описание свойства или события, описание параметров и так далее. VBdocman позволяет добавлять даже это описание автоматически, извлекая его из комментария к исходным кодом из специальных тегов. Он работает так же, как система JavaDoc. Но, пользователь не вынужден писать комментарии вручную, VBdocman добавляет его сам только двумя щелчками мыши. Все необходимые теги добавляются и пользователь затем заполняет только краткое описание к ним. Кроме того, он предоставляет сложные удобные комментарии редактора.
Преимущества:
Согласованности. Если что-то было добавлено в код, например, новый метод, это автоматически отражается в новой документации.
Документация в различных форматах может быть создана несколькими щелчками мыши. Таким образом, у вас есть документация во всех поддерживаемых форматах в течение нескольких минут.
Эффективная коммуникация внутри команды, особенно при использовании Source Safe. Каждый программист комментирует свою часть кода.
история версии
- Версия 2.25 размещено на 2005-11-09
Улучшенный выход и исправления ошибок.
Подробная информация о программе
Eula
EULA - Соглашение о лицензировании конечных пользователей
ЛИЦЕНЗИОННОЕ СОГЛАШЕНИЕ VBDOCMAN
VBdocman Add-In не является бесплатным. Это означает:
Все авторские права на VBdocman принадлежат исключительно автору - Питеру Мацею (HELIXOFT).
Любой человек может использовать это программное обеспечение в течение пробного периода в 14 дней.
После этого пробного периода в 14 дней или менее, если вы хотите продолжить
использовать VBdocman, вы должны зарегистрироваться (купить). Когда вы покупаете VBdocman, вы становитесь
зарегистрированного пользователя.
Есть следующие типы лицензий, выданных для VBdocman:
1. Лицензия на использование одного компьютера. Пользователь покупает лицензию ONE
ДЛЯ USE VBdocman на одном компьютере.
2. Лицензия SITE USAGE. Пользователь покупает единую лицензию USAGE,
разрешение USE VBdocman, покупателем, покупателями
сотрудников или аккредитованных агентов на неограниченном количестве компьютеров
в том же физическом месте SITE. Это местоположение SITE будет
как правило, определяется как одно здание, но может рассматриваться как
быть ряд зданий в пределах одного и того же, общего, географического
расположение, например, промышленная недвижимость или небольшой городок.
После регистрации пользователю предоставляется неисключаемая лицензия на использование
VBdocman на столько компьютеров, сколько определено условиями лицензирования выше
в зависимости от количества купленных лицензий, для любых юридических целей.
Вы не можете использовать, копировать, подражать, клонировать, арендовать, арендовать, продавать, изменять,
декомпонент, разобрать, в противном случае обратный инженер, или передать
лицензированной программы или любого подмножества лицензированной программы, за исключением
предусмотрено в этом соглашении. Любое такое несанкционированное использование должно
привести к немедленному и автоматическому прекращению действия этой лицензии и может
повесят уголовное и/или гражданское преследование.
Пробная версия VBdocman, может быть свободно распространена,
при условии, что пакет распределения не изменяется. Ни один человек или
компания может взимать плату за распространение VBdocman без письменного
разрешения автора.
Чтобы зарегистрироваться, смотрите сайт VBdocman http://www.vbdocman.com
ОГРАНИЧЕННАЯ ГАРАНТИЯ
Автор не гарантирует, что функции, содержащиеся в этом программном обеспечении
будет отвечать вашим требованиям или что программное обеспечение будет безошибочно.
НИ В ОДНОМ СЛУЧАЕ АВТОР НЕ БУДЕТ НЕСТИ ОТВЕТСТВЕННОСТЬ ПЕРЕД ВАМИ ЗА ЛЮБОЙ УЩЕРБ, ВКЛЮЧАЯ
ПОТЕРЯННАЯ ПРИБЫЛЬ, ПОТЕРЯННЫЕ СБЕРЕЖЕНИЯ ИЛИ ДРУГИЕ СЛУЧАЙНЫЕ ИЛИ КОСВЕННЫЕ УБЫТКИ
ИЗ-ЗА ИСПОЛЬЗОВАНИЯ ИЛИ НЕВОЗМОЖНОСТИ ИСПОЛЬЗОВАТЬ ЭТУ ПРОГРАММУ, ИЛИ ДЛЯ ЛЮБОЙ ПРЕТЕНЗИИ
ЛЮБОЙ ДРУГОЙ СТОРОНОЙ. ВЕСЬ РИСК, ЧТО КАСАЕТСЯ РЕЗУЛЬТАТОВ И ПРОИЗВОДИТЕЛЬНОСТИ
ПРОГРАММА И ДОКУМЕНТАЦИЯ ПРЕДПОЛАГАЕТСЯ ВАМИ.
Автор сохраняет право собственности на программное обеспечение. Все копии и
части программного обеспечения, в любой форме, принадлежат к автору, который сохраняет
все права прямо не предоставляются.
Установка и использование VBdocman означает принятие этих условий и
условия лицензии.
Если вы не согласны с условиями этой лицензии, вы должны удалить VBdocman
файлов с устройств хранения данных и прекратить использование продукта.
