Комментарии в PHP
Комментирование кода PHP
Комментарий в PHP-коде — это строка, которая при выполнении скрипта игнорируются препроцессором. Его единственная цель - быть прочитанным кем-то, кто просматривает код.
Часто при написании кода разработчики делают какие-либо комментарии в самом коде, которые никак не влияют на выполнение скрипта, а только поясняют его. Комментирование важно при создании больших проектов и в случаях, когда группа разработчиков работает над одной программой.
Виды комментариев в PHP
В коде любой программы гораздо проще разобраться если в нём присутствуют комментарии. Кроме того, когда задача решается по частям, недоделанные участки кода также следует комментировать, чтобы не забыть о них в дальнейшем.
В коде PHP можно использовать несколько видов комментариев: в стиле языков Cи, C++ и оболочки Unix. Символы // и # обозначают начало однострочных комментариев, /* и */ – соответственно начало и конец многострочных комментариев.
Многострочные комментарии удобны, когда примечания, которые вам нужно вставить в код, не помещаются на одной строке. Возможность отмечать целые блоки из строк в качестве комментариев позволяет избежать применения однострочного комментария в начале каждой строки блока.
Пример
Попробуй сам »<!DOCTYPE html>
<html>
<body>
<?php
// Это однострочный комментарий в стиле c++
# Это комментарий в стиле оболочки Unix
<h1>Это <?php # echo "простой"; PHP?> пример.</h1>
/*
Это многострочный комментарий
еще одна строка комментария
*/
// Использование комментариев для исключения частей кода
$x = 5 /* + 15 */ + 5;
echo $x;
?>
</body>
</html>
Ещё одно полезное применение многострочных комментариев — это временное отключение целых блоков кода PHP. Очень часто при написании PHP-скрипта возникает необходимость переписать его и сделать более эффективным. В этой ситуации можно закомментировать старый фрагмент кода, чтобы он программно не выполнялся, и написать новый код. Если окажется, что после запуска программы новый код хуже, чем закомментированный фрагмент, то можно удалить новый код и раскомментировать старый, чтобы вернуть его в поток выполнения.
