Как закомментировать код на PHP ?


Deprecated: Function create_function() is deprecated in /home/worldhel/public_html/wp-content/plugins/codecolorer/lib/geshi.php on line 4698

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

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

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

Однострочный комментарий в PHP применяется:

  • для быстрого заккомментирования одной-двух строчек кода;
  • а также применяется для того, чтобы оставить небольшой комментарий к коду
1
2
3
4
5
6
7
<?php

// Выводим дату
echo 'Сегодня дата ' . date('Y-m-d'); // в формате Год-Месяц-День

// Подумать, может выводить и время тоже
// echo 'Сегодня дата ' . date('Y-m-d H:i:s');

Однострочный комментарий в PHP это два символа слеша // . В примере кода выше имеется 4 таких комментария.

Любой текст, код который находится за последовательностью символов // будет проигнорировано интерпретатором PHP и не будет обрабатываться.

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

Сегодня дата 2019-03-25

Многострочный комментарий

В случае, когда комментарием одной строкой не обойтись, то следует использовать многострочный комментарий. Его синтаксис следующий:

/* .....
....
...
.... */

Любой текст или код, который будет заключен, между симовалами /* и */ воспринимается как комментарий и не будет обработан.

Гораздо чаще многострочный комментарий будет выглядеть, как:

/*
* Здесь некоторый текст
* Еще немного текста
* ......
*/

Также многострочный комментарий может быть записан в одну строку:

/* здесь некоторый комментарий */

Наиболее часто в профессиональной разработке на PHP вы будете встречать и использовать сами, многострочные комментарии в стиле PHPDoc (для чего такие комментарии используются, подробнее будет в отдельной статье):

1
2
3
4
5
6
7
8
9
10
<?php

/**
 * @param array $numbers
 *
 * @return float|int
 */

function getSum(array $numbers) {
    return array_sum($numbers);
}

Как можете обратить внимание, что в примере кода выше, такой специальный многострочный комментарий описывает тип входных аргументов (array), и тип возвращаемого значения (float или int) для функции getSum().

Будут ли видны Ваши комментарии в браузере?

Написанный вами PHP код выполняется только на сервере, и результат работы любого скрипта PHP этот текст, который уже отдается в браузер. В случае ВЕБ программирования результатом работы PHP скриптов, как правило является сгенерированыый HTML документ с тегами. И самое главное, что интерпретатор php, выполняя скрипт, игнорирует все строки заключенные в символы комментариев.

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

Резюмируем.

При написании кода на языке программирования PHP принято использовать однострочные комментарии (//………) и многострочные комментарии (/* ………………… */).

Книга о паттернах проектирования от Банды Четырех.

«Приёмы объектно-ориентированного проектирования. Паттерны проектирования» (Design Patterns: Elements of Reusable Object-Oriented Software) — книга 1994 года о программной инженерии, описывающая шаблоны проектирования программного обеспечения. Авторами книги, которых прозвали «Бандой четырёх»[, являются Эрих Гамма, Ричард Хелм, Ральф Джонсон (англ.)русск., Джон Влиссидес. Предисловие написал Гради Буч.

Подробнее

О-большое. Оценка скорости алгоритма

Специальная нотация «О-большое» описывает скорость работы алгоритма. Зачем вам это? Время от времени вам предется использовать чужие алгоритмы. Поэтому неплохо было бы понимать, насколько быстро или медленно они работают. В этой статье я объясню, что представляет собой «О-большое», и приведу список самых распространенных вариантов времени выполнения для некоторых алгоритмов.

Подробнее

Сервис-контейнер в Symfony 4

Ваше приложение полно полезных объектов: объект «Mailer» может помочь вам отправлять электронные письма, в то время как другой объект может помочь вам сохранить данные в базе данных. Почти все, что «делает» ваше приложение, на самом деле выполняется одним из таких объектов. И каждый раз, когда вы устанавливаете новый бандл, вы получаете доступ к еще большим возможностям!

Подробнее

PSR-3. Общий интерфейс для ЛОГИРОВАНИЯ.

Данная статья, это авторский перевод, описания стандарта. С оригиналом описания Вы можете ознакомиться здесь.

Этот документ описывает общий интерфейс для библиотек логирования.

Основная цель — позволить библиотекам получать Psr\Log\LoggerInterface объект и записывать в нем логи простым и универсальным способом. Фреймворки и CMS, имеющие пользовательские потребности, МОГУТ расширять интерфейс для своих собственных целей, но ДОЛЖНЫ оставаться совместимыми с этим документом. Это гарантирует, что сторонние библиотеки, используемые приложением, могут записывать в централизованные общие логи приложения.

Подробнее