// (single line comment)
Однострочный комментарий // заставляет компилятор игнорировать всё до конца строки: удобно для пояснений или временного отключения фрагмента кода.
Полная статья
Описание
Комментарий — это фрагмент текста в скетче, который компилятор пропускает и никогда не записывает в память микроконтроллера. Комментарии не влияют на работу программы и не занимают место во флэш-памяти. Их единственная задача — сделать код понятным: для вас самих через несколько месяцев, для коллег, которые будут читать ваш скетч, или для тех, кто учится по вашему примеру.
Однострочный комментарий начинается с // — двух косых черт подряд. Всё, что стоит после // и до конца строки, компилятор игнорирует. Можно начать комментарий с самого начала строки, а можно дописать его в конце строки с кодом.
Пример кода
Существует два разных способа пометить строку как комментарий:
// На большинстве плат Arduino к pin 13 подключён светодиод.
// Дадим ему имя:
int led = 13;
digitalWrite(led, HIGH); // Включаем светодиод (HIGH — высокий уровень напряжения)
Где применяется
- Пояснение логики — объяснить, почему выбрано именно такое значение задержки или почему используется конкретный пин.
- Временное отключение кода — «закомментировать» строку, чтобы проверить, как программа ведёт себя без неё, не удаляя код совсем.
- Отладка — если скетч не компилируется, а сообщение об ошибке неинформативно, можно последовательно закомментировать подозрительные строки и найти проблемное место.
- Документирование пинов — в начале скетча удобно однострочными комментариями описать, что подключено к каждому выводу платы.
Практические замечания
- Однострочный комментарий работает только до конца текущей строки. Если нужно закомментировать несколько строк сразу, удобнее использовать блочный комментарий
/* ... */. - Большинство редакторов, включая Arduino IDE, позволяют выделить несколько строк и нажать сочетание клавиш (обычно
Ctrl+/илиCmd+/), чтобы закомментировать или раскомментировать их все сразу. - Не злоупотребляйте комментариями там, где код и так очевиден — это загромождает файл. Комментируйте то, что не очевидно: нестандартные решения, магические числа, порядок инициализации.
- Закомментированный код, который вы оставили «на всякий случай», лучше через какое-то время удалить — система контроля версий сохранит историю, а скетч останется чистым.