Бесплатный курс по PHP. Зарегистрируйтесь для отслеживания прогресса →

PHP: Комментарии

Зачем нужны комментарии

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

Комментарии в PHP бывают двух видов:

  • Однострочные комментарии — начинаются с //. После этих символов может следовать любой текст, вся строка не будет анализироваться и исполняться:
  <?php

  // For Winterfell!
  // For Lanisters!
  // Комментарий может находиться на строке после какого-нибудь кода
  print_r('I am the King'); // For Lannisters!
  • Многострочные комментарии — начинаются с /* и заканчиваются на */. Между ними каждая строка должна начинаться с символа *:
  <?php
  /*
   * The night is dark and
   * full of terrors.
   */
  print_r('I am the King');

Задание

Создайте однострочный комментарий с текстом: You know nothing, Jon Snow!.

Упражнение не проходит проверку — что делать? 😶

Если вы зашли в тупик, то самое время задать вопрос в «Обсуждениях». Как правильно задать вопрос:

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

Тесты устроены таким образом, что они проверяют решение разными способами и на разных данных. Часто решение работает с одними входными данными, но не работает с другими. Чтобы разобраться с этим моментом, изучите вкладку «Тесты» и внимательно посмотрите на вывод ошибок, в котором есть подсказки.

Мой код отличается от решения учителя 🤔

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

В редких случаях бывает, что решение подогнано под тесты, но это видно сразу.

Прочитал урок — ничего не понятно 🙄

Создавать обучающие материалы, понятные для всех без исключения, довольно сложно. Мы очень стараемся, но всегда есть что улучшать. Если вы встретили материал, который вам непонятен, опишите проблему в «Обсуждениях». Идеально, если вы сформулируете непонятные моменты в виде вопросов. Обычно нам нужно несколько дней для внесения правок.

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

Определения

  • Комментарий — текст в коде программы, который не влияет на функциональность, и добавляется программистами для себя и своих коллег.

    // однострочный комментарий

    /*
    * многострочный комментарий
    * многострочный комментарий
    */
    


Нашли ошибку? Есть что добавить? Пулреквесты приветствуются https://github.com/hexlet-basics
Если вы столкнулись с трудностями и не знаете, что делать, задайте вопрос в нашем большом и дружном сообществе