Документирование кода Visual Basic 6.0

Question

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

Есть ли хорошее программное обеспечение, бесплатное или нет, которое могло бы сделать что-то похожее на javadoc там для VB6, что может быть полезно?

Или просто если у кого-нибудь есть предложения по инструментам/методам, как это сделать. Любой совет будет очень благодарен.

Answer 1

Вы можете найти мою надстройку, Atomineer Pro Documentation полезной. Он может генерировать и обновлять комментарии JavaDoc, Qt, Doxygen и Xml-Documentation в исходном коде (Visual Basic, C#, C++/CLI, C++, C, Java, unrealscript), и у вас есть большой контроль над форматом, который он создает.

(изменить: обратите внимание, что это дополнение работает только в версиях Visual Studio начиная с 2005 года, поэтому вы не можете использовать его в VB6, только для документирования старого кода VB6 с использованием более новой версии Visual Studio. все же, конечно, можно перезагрузить и скомпилировать в VB6)

(Вы могли бы сказать, что он создает для вас документацию по «шаблону», но он генерирует намного больше, чем просто базовый скелет шаблона - он заполняет столько деталей, сколько можно свести к минимуму количество дополнительной документации, которую вам нужно написать)

Таким образом, он не создает внешнюю документацию от комментариев (например, JavaDoc), он создает сами комментарии, поэтому вам понадобится еще один инструмент для создания внешней документации. Однако AtomineerUtils сэкономит много времени, если вам придется генерировать новые комментарии к документации для существующего (недокументированного) кода, или если у вас уже есть код, прокомментированный/документированный в стиле Javadoc, AtomineerUtils может обрабатывать комментарии к документации, чтобы преобразовать их в Doxygen или форматы документации XML, что может помочь вам получить совместимость с другими инструментами (Sandcastle и т. д.), которые могут создавать для вас внешнюю документацию.

Чтобы создать внешнюю документацию из комментариев исходного кода, Doxygen является ведущим (и бесплатным) средством создания внешней документации, которое может создавать документацию из документации документации XMLDoc, Qt, Doxygen или Dououmentation-XML и хорошо стоит попробовать.

Answer 2

Раньше я использовал код в VB6, и я никогда не встречал никаких достойных инструментов, которые помогли бы с документацией в смысле Javadoc.

Я хотел бы подходить к этому с точки зрения того, что необходимо задокументировать: это для разработчиков, чтобы понять API или это для пользователя для работы с приложением? Предполагая первое, тогда какой минимальный минимум вы можете избежать, чтобы разработчик мог следить за тем, что происходит? Возможно, вам удастся избежать документирования каждого метода и просто предоставить общий рутинный подход, основанный на использовании, который может быть полностью отделен от кода и основываться на ваших исследованиях. Несколько хороших диаграмм имеют большое значение для передачи понимания.

Если пользователь должен работать с приложением, то вы попадаете в области компилятора справки. Возможно, вам повезло и найти один из этих лотов по-прежнему: http://help-compiler.qarchive.org/

В противном случае, если он должен быть эквивалентом Javadocs или вам не платят, тогда вам может потребоваться написать инструмент для сканирования исходный код и выполнить большую часть заполнения параметров шаблона для вас. Инструмент вроде Unix AWK действительно может помочь здесь.

Answer 3

Наш VBdocman выполняет именно то, что вам нужно. Он использует комментарии javaDoc и может генерировать несколько выходных форматов.

Answer 4

Вы можете попробовать VBDox, который является бесплатным генератором документации по исходному коду VB6.