Авто документирование кода - инструмент для автоматизации вставки комментариев описывающих основной функционал модулей, процедур и функций

Основные преимущества документированного кода:

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

Даже с учетом всех вышеперечисленных преимуществ, документирование, в целом, является трудоемким процессом.

Для того, чтобы обеспечить более быстрый процесс подготовки документации, вам стоит использовать специальные инструмент – “авто документирование кода VBA”.

Вставка описательных комментариев к модулю, процедурам и функциям:

  1. Кнопка “Создать комментарий” – вставляет комментарий для активного модуля, процедуры или функции в зависимости от нахождения курсора
  2. Кнопка “Создать строку комментария обновления” – добавляет к созданному комментарию, строку обновления
  3. Кнопка “Создать TODO” – добавляет строку комментария с метко сделать
Инструмент авто документирования кода VBA инструментом надстройки MacroToolsVBA
Инструмент авто документирования кода VBA
  1. Кнопка “Список TODO” – открывает форму со списком всех меток “TODO”. Отображает: тип модуля, название модуля, номер строки с меткой TODO, информацию о метке. При двойном клике происходит переход к модулю VBA с меткой “TODO”.
Список меток TODO инструмента Macro Tools VBA
Форма TODO отображающая список меток

Форма настроек авто документирования кода VBA, можно изменить вывод полей комментарий. Если “Имя автора” – пусто, то выводится системное имя, остальные поля если пусто, то не выводятся в основном комментарии.

Настройки инструмента авто документрирование кода
Форма настроек инструмента авто документирования кода VBA