многострочные комментарии против однострочных комментариев - PullRequest
7 голосов
/ 13 марта 2012

Я помню, как читал в руководстве по JavaScript, что, как правило, лучше избегать использования однострочных комментариев, если в будущем кто-то решит сжать файл и удалить все пробелы.

То же самое звучит в PHP? Следует ли использовать многострочные комментарии, даже если я буду занимать только одну строку, например,

echo $var; /*This code echoes a variable*/ 

или в таких ситуациях нормально использовать однострочные комментарии?

И сжаты ли когда-нибудь файлы PHP путем удаления пробелов, или это немного экстремально?

Ответы [ 2 ]

5 голосов
/ 13 марта 2012

нормально ли использовать однострочные комментарии в таких ситуациях?

Краткий ответ: Да .
Если кто-то сжимает пробелы и нарушает ваш код,они виноваты в том, что сделали это неправильно.

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

Единственная практическая причина, по которой я могу придумать, чтобы избежать однострочных комментариев, заключается в том, что иногда возникают проблемы с окончаниями строк при переходе на / с сервера Windows и * NIX,Если вы используете переводы строк в стиле Windows и ваш файл сохраняет их на сервере * NIX, ваши однострочные комментарии в итоге закомментируют ваш реальный код, испортив все./* Comments like this */ ни на что не повлияет.Пример:

$var = 'Hello'; // Say hello
echo $var;

Загрузка на сервер UNIX в стиле Windows \r\n переводы строк:

$var = 'Hello'; // Say helloecho $var;

В результате вы можете выполнить какой-то непредвиденный и опасный код, если вы его запустите.

Однако : Если это произойдет, это признак другой проблемы, которая должна быть решена в любом случае.У меня такое случалось со мной несколько раз, поэтому я знаю, что это возможно.Многие FTP-клиенты в любом случае преобразуют переводы строк.

В действительности: Да, хорошо использовать однострочные комментарии. Комментарии предназначены для автора, а не для компилятора или парсера.

0 голосов
/ 13 марта 2012

Сжатие PHP-сценариев путем свертывания пробелов может на самом деле быть плохим, поскольку 1) это может изменить представление HTML в браузере, что приведет к различиям в разметке, и 2) некоторые функции, такие как x lag to preg_*(),нужен пробел, чтобы остаться без изменений.

...