Рассылка закрыта
При закрытии подписчики были переданы в рассылку "Заметки Дизайнера" на которую и рекомендуем вам подписаться.
Вы можете найти рассылки сходной тематики в Каталоге рассылок.
БАЗОВЫЙ СИНТАКСИС: Стиль кодирования
PHP 5 для начинающих
Вниманию читателей!
Отдельные выпуски рассылки в той или иной мере взаимосвязаны. С предыдущими выпусками Вы можете ознакомиться:
- в архиве рассылки (оригиналы выпусков);
- на сайте рассылки (исправленные и дополненные версии).
# # #
Вы также можете подписаться на рассылку "PHP 5: Новые возможности".
PHP 6 уже в разработке!
Еще в ноябре 2005 года на встрече в Париже разработчики обсудили новые возможности следующей, шестой, версии PHP. Интересует ли Вас, какой будет эта версия? Примите участие в опросе, который проводится на сайте рассылки.
http://pterodactyl.l2p.net/e107/
[опрос на английском языке: PHP 6: Are you interesting in? (PHP 6: Вы зантересованы?) - YES (ДА) - NO (НЕТ)]
Аннотация
Рекомендации по эффективному оформлению кода.
Под стилем кодирования будем понимать определенный набор приемов по оформлению создаваемого кода.
В отличие от правил синтаксиса, нарушение которых чревато непредсказуемыми результатами, вплоть до полной неработоспособности приложения, стиль кодирования не оказывает какого-либо влияния на исполнение скрипта. В то же время, эффективный стиль кодирования позволяет сократить затраты времени на отладку и снижает вероятность ошибок.
Особенно важно соблюдение определенного (единообразного) стиля в случае работы в команде. Сравнительно высокие требования предъявляются также к оформлению кода, который подлежит дальнейшему распространению.
Примером хорошего стиля, доведенного до уровня стандарта, является код приложений к PHP, входящих в состав PEAR. Изложенные далее рекомендации базируются именно на этом стандарте [1].
Кодировка. При написании скриптов следует пользоваться кодировкой ISO-8859-1. Из этого, в частности, следует, что комментарии должны быть написаны на английском языке. При разработке локазизованных приложений, чтобы максимально ссблюсти данное требование и облегчить последующую разработку других локализаций, желательно выносить все текстовые элементы в отдельные файлы (по одному ресурсному файлу на каждый поддерживаемый язык).
Тэги. Для гарантированной совместимости следует всегда использовать классическую форму (<?php ?>). После закрывающей части тэга в конце файла должен присутствовать один перевод строки.
Документирование. Даже если код кажется предельно простым и понятным, он может вызвать вопросы у другого разработчика или у самого автора спустя несколько недель или месяцев после написания. Поэтому при разработке скриптов следует обязательно их документировать при помощи комментариев. Предпочтительнее использовать встроенную документацию (тогда впоследствии можно будет автоматически генерировать внешнюю документацию к приложению) в начале скрипта (общее описание) и перед каждым крупным блоком кода (описание блока). Мелкие блоки можно комментировать при помощи обычных многострочных или однострочных комментариев (из однострочных следует отдавать предпочтение комментариям в стиле C++). Не нужно, однако, бросаться в другую крайность и комментировать каждую строку кода.
Форматирование. Не стесняйтесь использовать для форматирования кода пробельные символы. Разделяйте смысловые блоки кода дополнительным переводом строки (пустой строкой). Используйте отступы для структуризации кода (подробнее об этом будет рассказано при изучении структурных элементов языка). Отступы рекомендуется делать при помощи пробелов и одинаковой длины (например, из 4 пробелов).
Подсказка
Большинство текстовых редакторов позволяют настроить длину отступа и автоматически заменять необходимым количеством пробелов символ табуляции (клавишей табуляции для создания отступов пользоваться значительно удобнее и привычнее).
Инструкции. Следует избегать размещения нескольких, даже коротких, инструкций на одной строке.
Длина строки. Чрезмерно длинные строки (более 75..85 символов) плохо воспринимаются и неудобны для редактирования. Их желательно разбивать на несколько отдельных строк, делая отступ в начале каждой строки, кроме первой.
print 'This is just a simple example of a very very very very very very
long string.';
По мере дальнейшего изучения элементов языка разговор о правильном их оформлении будет продолжен.
| В избранное | ||
