/* */ (block comment)

Описание

Комментарии — это текст внутри скетча, который компилятор полностью пропускает. Они не попадают в прошивку и не занимают места во флэш-памяти микроконтроллера. Их единственная задача — помочь вам и другим разработчикам разобраться в том, как работает программа.

Блочный (многострочный) комментарий начинается с /\* и заканчивается символом */. Всё, что находится между /\* и */, компилятор игнорирует — независимо от того, сколько строк занимает этот фрагмент.

Пример кода

    /* Это допустимый комментарий */

    /*
      Blink
      Включает LED на одну секунду, затем выключает на одну секунду, и так повторяется.

      Этот пример кода находится в общественном достоянии.
      (Ещё один допустимый комментарий)
    */

    /*
      if (gwb == 0) { // однострочный комментарий внутри многострочного допустим
        x = 3;          / но не другой многострочный комментарий — это недопустимо */
      }
    // не забудьте «закрывающий» комментарий — они должны быть сбалансированы!
    */

Где применяется

• Описание скетча в начале файла — удобно кратко объяснить, что делает программа, какие пины используются и какие библиотеки нужны.
• Временное отключение блока кода — если нужно проверить поведение скетча без определённого фрагмента, достаточно обернуть его в /* */, не удаляя.
• Объяснение сложной логики — когда несколько строк подряд реализуют нетривиальный алгоритм, блочный комментарий перед ними избавляет от необходимости ставить // в начале каждой строки.
• Документирование функций — перед объявлением функции можно описать её параметры и возвращаемое значение в одном блоке.

Практические замечания

• Блочные комментарии нельзя вкладывать друг в друга: первый же */ закроет весь блок, даже если внутри был ещё один /*. Это частая причина ошибок компиляции при попытке закомментировать уже закомментированный код.
• Для коротких однострочных пояснений удобнее использовать // — он проще в наборе и не требует закрывающего символа.
• Если компилятор выдаёт непонятную ошибку, попробуйте «закомментировать» подозрительный блок с помощью /* */ и скомпилировать снова — это быстро сужает область поиска проблемы.
• В большинстве редакторов (включая Arduino IDE) выделенный фрагмент кода можно закомментировать горячей клавишей, которая автоматически расставит // перед каждой строкой — это безопаснее, чем блочный комментарий, именно из-за проблемы вложенности.
• Блочный комментарий отлично подходит для временного хранения альтернативной версии кода: старый вариант остаётся рядом с новым и не мешает компиляции.