Коментарі – це текст в початковому коді програми, який використовують програмісти для пояснення написаних ними процедур, функцій, оголошених констант та змінних. Цей текст ігнорується компілятором і ніяк не впливає ні на розмір, ні на швидкість виконання програми.
Можна сказати, що коментарі – це короткі нотатки, написані людиною для людини. Адже через два-три місяці (а може навіть і через кілька днів) ви вже не згадаєте для чого оголошували ту чи іншу змінну, або що виконує та чи інша процедура. А прочитавши коротке пояснення, ви відразу згадаєте, для чого було створено конкретну змінну, константу, функцію або процедуру. Також коментарі дуже корисні в тому випадку, якщо після вас з програмним кодом працюватиме хтось інший. Почитавши коментарі, цій людині буде набагато простіше розібратися в чужому коді.
Як створювати коментарі в 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.
Примітка.
Якщо рядок вже починається з апострофа, а ви його виділили та натиснули кнопку Comment Block, то на початок цього рядка буде додано ще один апостроф.
Так само, кожне натискання на кнопку Uncomment Block прибирає лише один апостроф.
Рекомендації щодо написання коментарів
Внесення до тексту програми коментарів вважається дуже хорошим тоном в програмуванні. Я рекомендую при написанні складних програм робити короткі пояснення до кожного рядка коду. Надалі це дасть можливість швидше орієнтуватися в коді та швидко знаходити необхідні ділянки при налагодженні програми та внесенні коректив до неї.
При оголошенні змінної додайте коментар про те, для чого ви її створюєте і де її використовуватимете.
При написанні процедури або функції коротко опишіть її призначення та спосіб використання.
