PHP

Комментарии в PHP: как закомментировать строку и часть кода

Короткий ответ: в PHP есть однострочные комментарии // и #, а также многострочный комментарий / ... /. Для обычной работы чаще всего используют //, а большой фрагмент временно отключают через / ... /

Комментарий не выполняется интерпретатором PHP. Его задача — пояснить код или временно выключить часть программы на время проверки

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

Самый частый вариант — две косые черты

<?php

$price = 1500; // цена товара в рублях

// Скидка пока отключена
$discount = 0;

echo $price - $discount;

Все, что стоит после // до конца строки, PHP игнорирует. Код слева от комментария продолжает выполняться

Комментарий через решетку

В PHP также работает вариант с #

<?php

# Временно выводим тестовое сообщение
echo 'Проверка страницы';

Такой стиль встречается реже. В учебных и командных проектах лучше придерживаться одного варианта, обычно //

Как закомментировать часть кода

Для большого фрагмента используют блочный комментарий

<?php

/*
$name = 'Динар';
$email = 'test@example.com';
mail($email, 'Тема письма', 'Текст письма');
*/

echo 'Отправка письма временно отключена';

PHP пропустит все между / и /. Такой прием удобен, если нужно быстро проверить страницу без определенного блока

Почему нельзя вкладывать блочные комментарии

Новички часто делают так

<?php

/*
echo 'Первый блок';

/*
echo 'Вложенный блок';
*/

echo 'Конец';
*/

Так писать нельзя. PHP увидит первый */ как конец комментария, а оставшаяся часть может превратиться в синтаксическую ошибку. Если внутри фрагмента уже есть блочные комментарии, отключайте строки через // или удаляйте фрагмент аккуратно в редакторе

Как отключить одну строку в PHP

Если нужно временно выключить строку, поставьте // в начало

<?php

echo 'До проверки';

// echo 'Эта строка временно отключена';

echo 'После проверки';

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

Комментарии внутри HTML и PHP

Если PHP смешан с HTML, важно понимать разницу

<!doctype html>
<html lang="ru">
<body>
    <!-- Это HTML-комментарий, он может попасть в исходный код страницы -->

    <?php
    // Это PHP-комментарий, браузер его не увидит
    echo '<p>Текст на странице</p>';
    ?>
</body>
</html>

HTML-комментарий может быть виден в исходном коде страницы браузера. PHP-комментарий остается на сервере и не попадает в готовый HTML, если файл выполняется через PHP

Хороший комментарий и плохой комментарий

Плохой комментарий просто повторяет очевидное

<?php

// Создаем переменную name
$name = 'Динар';

Лучше объяснять не то, что написано в строке, а почему принято такое решение

<?php

// Имя показываем в письме, поэтому очищаем его перед выводом
$name = trim($_POST['name'] ?? '');

Такой комментарий помогает будущему читателю кода понять намерение

Мини-практика

Создайте файл comments.php и вставьте код

<?php

$title = 'Комментарии в PHP';
$debug = true;

// echo 'Отладка включена';

/*
echo 'Этот блок сейчас не выполняется';
echo 'Его можно вернуть позже';
*/

echo $title;

Запустите файл через локальный сервер или команду php comments.php. Потом уберите // перед строкой отладки и посмотрите, как изменится вывод

Частые ошибки

Ставят комментарий внутри строки Если // стоит внутри кавычек, это просто текст, а не комментарий

*Вкладывают / / друг в друга* Блочные комментарии в PHP нельзя нормально вкладывать

Оставляют временно отключенный важный код Если вы закомментировали отправку письма, проверку доступа или сохранение в базу, верните это перед публикацией

Используют HTML-комментарий для PHP-кода  не заменяет PHP-комментарий внутри PHP-блока

Что почитать дальше по PHP

Если нужен общий маршрут по теме, откройте рубрику PHP. Для соседних задач пригодятся эти разборы:

0 комментариев

Старые

Новые Популярные