1.3 - Использование комментариев в PHP

Комментарии нужны в программировании для объяснения действий определенный строк кода программы. Казалось бы, а что там не понятного? Попробуйте взять чужой код php и быстро разобраться в нем. Ключевое слово "быстро". Вот благодаря комментариям, процесс разбирания кода PHP, да и вообще любого другого языка программирования, значительно ускоряется. Т.е. время потраченное на понимание "что тут происходит" сокращается в несколько раз. Конечно можно возразить: "Я не буду разбирать чужой код, а свой я и так знаю наизусть". Но представьте себе - вы пишите код программы, несколько тысяч строк кода, несколько дней пишите. И тут у вас возникает перерыв в несколько дней. Потом возвращаетесь к этому коду... И поверьте он станет для вас чужим... Некоторое время вы с трудом будете понимать что и где в этом коде происходит. А комментарии вам помогут быстро разобраться что к чему.

Ну думаю хватит лирики)))

Итак, есть несколько видов комментариев в языке PHP.

Первый из них это однострочный комментарий в стиле C++ (//).

Пример однострочного комментария

<?php     
  // комментарий до конца строки 
?>

Данный комментарий начинается с двух слешей и заканчивается в конце строки или при закрытии блока кода PHP.

Пример

<?php 
  // echo не сработает команда 
?> 
<?php 
  echo 'Выведет этот текст'; 
?>

Как видно из примера - код написан в одну строку и в первом блоке кода вставлен комментарий. Но из-за закрытия блока кода комментарий на этом заканчивается и во втором блоке кода функция echo сработает.

Еще один вариант комментария в одну строку - это с использованием решетки # (в стиле UNIX)

<?php     
  # комментарий до конца строки 
?>

Подробностей думаю не стоит.

Совсем другое дело - многострочные комментарии. Это комментарии в несколько строк (в стиле C). Начинаются такие комментарии со знаков /* и заканчиваются */.

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

<?php     
  /* это     
  многострочный     
  комментарий */ 
?>

Тут тоже все просто слеш и звездочка (/*) открыли комментарий. Звездочка и слеш (*/) закрыли комментарий. Единственный момент - опасайтесь вложенных комментариев.

<?php     
  /*      
    echo "Просто текст"; 
    /* Этот комментарий вызовет ошибку */    
  */ 
?>

Почему? Все просто многострочный комментарий начинается как уже говорилось со знака /* и все что идет после него интерпретатор игнорирует. Все кроме знака */. Как только интерпретатор натыкается на такой знак (*/) то считает, что комментарий закончился и далее идет код PHP.

Список уроков