Комментарии в VBA. Урок №17

Комментарии – это текст в исходном коде программы, который используют программисты для пояснения написанных ими процедур, функций, объявленных констант и переменных. Этот текст игнорируется компилятором и соответственно никак не влияет ни на размер, ни на скорость выполнения программы.

Можно сказать, что комментарии – это короткие заметки, написанные человеком для человека. Ведь спустя два-три месяца (а может даже и через несколько дней) вы уже не вспомните для чего объявляли ту, или иную переменную, или что выполняет та, или иная процедура. А прочитав короткое пояснение, вы сразу вспомните, для чего была создана конкретная переменная, константа, функция, или процедура. Также комментарии очень полезны в том случае, если после вас с программным кодом будет работать кто-то другой. Почитав комментарии, этому человеку будет намного проще разобраться в чужом коде.

Как создавать комментарии в VBA

Комментарии в VBA записывают после знака апострофа (‘). Обозначить комментарий можно в любом месте строки. Всё что написано сразу после апострофа и до самого конца строки – это комментарий.

Sub myAlert()
'это комментарий
    MsgBox "Демонстрация написания комментариев в VBA" 'это тоже комментарий (до апострофа – код программы, а всё что после апострофа – это комментарий)
'это ещё один комментарий
End Sub

Комментарии можно размещать как в отдельных строках, так и после операторов программы.

Есть только одно место в окне программного кода, где разместить комментарий у вас никак не получится – это конец строки, в которой используется символ переноса строки (символ подчеркивания).

Например, если вы попытаетесь разместить комментарий так, как показано в примере ниже, то вы увидите перед собой сообщение об ошибке «Compile error. Invalid character» сразу после попытки ввести комментарий и «Compile error. Syntax error» при попытке запустить программу.

Sub myAlert()
'это комментарий
    MsgBox "Демонстрация ошибки при написании комментариев" _ 'сразу перед апострофом стоит символ подчёркивания. Это приведёт к ошибке
'это ещё один комментарий
End Sub

Многострочные комментарии в VBA

На панели инструментов окна редактирования кода VBA есть две кнопки: Comment Block и Uncomment Block.

Если вы хотите быстро заккоментировать несколько строк кода, то нужно выделить эти строки и нажать на кнопку Comment Block.

Чтобы раскомментировать несколько строк одновременно, нужно выделить их и нажать Uncomment Block.

Если в вашем окне редактирования кода VBA нет панели инструментов с вышеупомянутыми кнопками, то отобразить их можно, отметив в меню редактора VBA пункт Viev → Toolbars → Edit.

Рекомендации по написанию комментариев

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

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

При написании процедуры, или функции, коротко опишите её назначение и способ использования.