Изучаем комментарии в PHP
Комментарии делают PHP-код понятнее и снижают риск ошибок. Даже простой скрипт без пояснений со временем превращается в источник путаницы и требует больше усилий при доработке.
Вы научитесь основным способам комментирования в PHP и поймете, когда и как лучше добавлять пояснения к коду. На примерах вы увидите, как комментарии упрощают поддержку проектов, ускоряют работу и помогают избегать ошибок при доработке.
Однострочные комментарии в PHP
Перед комментариями, которые находятся на одной строке, в PHP ставятся два символа косой черты (//).
Следующий пример содержит однострочный PHP комментарий в коде:
<?php
// Это однострочный комментарий
?>Однострочный комментарий может находиться на отдельной строке, или добавляется в конец строки кода:
<?php
echo "Это проверочная строка"; // Вывести строку текста
?>В примере, приведенном выше, препроцессор PHP выполнит функцию echo и проигнорирует все, что расположено после //.
Однострочные комментарии также применяются, чтобы временно убрать строки кода из потока выполнения. Например, следующее изменение предыдущего примера приведет к тому, что PHP проигнорирует всю команду echo во время выполнения:
<?php
// echo "Это проверочная строка";
?>Многострочные комментарии в PHP
Многострочные комментарии для сайта PHP обернуты разделителями /* и */. Знак /* обозначает начало блока комментариев, а */ указывает на его конец. Следующий пример демонстрирует использование многострочного комментирования:
<?pre
/*
Это многострочный блок
комментариев
*/
?>Многострочные комментарии полезны, когда заметки, которые вы хотите вставить в код, занимают более одной строки. Возможность помечать блоки строк как комментарии позволяет избежать использования однострочного комментария в начале каждой строки.
Другое полезное применение многострочных комментариев — временное отключение блоков кода PHP. Распространенная практика — написать PHP-скрипт и размышлять, можно ли переписать его так, чтобы он стал более эффективным. В данной ситуации можно закомментировать старый фрагмент кода, чтобы он больше не выполнялся, и написать новый. Если окажется, что новый код хуже оригинала, то можно в PHP удалить комментарии и новый код. А затем раскомментировать старый, чтобы вернуть его в поток выполнения.
Итоги
И однострочные, и многострочные комментарии можно легко добавить в PHP- код, используя специальный синтаксис. Постарайтесь выработать привычку комментировать свой код.
Теперь, когда мы усвоили некоторые базовые понятия PHP, настало время изучить основы этого языка программирования, начиная с введения в переменные PHP.
Комментарии