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

<?php

// Удалить строку ниже после реализации задачи по регистрации
print_r(10);

Однострочные комментарии в PHP начинаются с символов // или #, после которых может идти любой текст. Все, что написано после них до конца строки, интерпретатор игнорирует.

// комментарий      ──→  [ пропущено интерпретатором ]
print_r('hello');   ──→  [ выполнено → hello ]
// еще один         ──→  [ пропущено интерпретатором ]

Комментарий может занимать всю строку:

<?php

// For Winterfell!
// For Lanisters!

Или стоять в конце строки с кодом:

<?php

print_r('I am the King'); // For Lannisters!

Если нужно оставить длинное пояснение, используют несколько строк с //:

<?php

// The night is dark and
// full of terrors.
print_r('I am the King');

Для таких случаев в PHP есть и специальный вид — многострочные комментарии. Они начинаются с /* и заканчиваются на */, а каждую строку между ними принято начинать с символа *:

<?php

/*
 * The night is dark and
 * full of terrors.
 */
print_r('I am the King');

Интерпретатор игнорирует комментарии. Разработчики благодаря им быстрее разбираются в чужом коде и не забывают важные детали в собственном.

Служебные комментарии

В процессе работы вы будете встречаться с таким кодом в нашем редакторе:

// BEGIN

// END

BEGIN и END здесь это обычные комментарии, которые никак не влияют на работу программы. Они показывают, куда писать код задания.

// BEGIN
<здесь ваше решение>
// END

Увидев BEGIN и END, пишите свой код между ними, остальное оставляйте без изменений.

Вы пишете программу и понимаете, что одну часть нужно доделать позже. Чтобы не забыть, программисты оставляют себе заметки прямо в коде — TODO-комментарии.

Добавьте в файл такой комментарий:

// TODO: добавить функцию приветствия

Когда вернётесь к этому месту позже, комментарий напомнит, что здесь ещё есть незавершённая работа.