2012-03-12 2 views
7

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

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

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

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

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

+4

Можете ли вы сослаться на ссылку, где вы получили эту информацию? Любой, кто сжимает пустое пространство, должен понимать, что не все белые пробелы являются съемными, есть много вещей, которые могут пойти не так. Конечно, комментарии должны быть разделены, прежде чем делать что-то подобное. –

+0

Кстати: да иногда люди сжимают или обфускают PHP, но редко. –

+0

Извините за поздний ответ, сайт был: http: //dev.opera.com/articles/view/javascript-best-practices/# comments В частности: «Комментарий, когда есть что сказать, и если вы делаете комментарий, используйте нотацию/* * /. быть проблематичным, если люди уменьшают ваш код без снятия комментариев и вообще менее универсальны ». – Sean

ответ

5

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

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

Любой компрессор источника 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

Awesome, спасибо :) – Sean

0

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

Смежные вопросы