Стандарты кодирования PHP

Question

Я искал несколько рекомендаций по компоновке кода PHP. Я нашел несколько хороших ссылок, таких как:

http://www.dagbladet.no/development/phpcodingstandard/

и этот вопрос на SO.

Однако ничего из этого не доходит до того, что меня особенно интересует, - это интеграция HTML и PHP. Например:

1. Можно ли иметь файл PHP, начинающийся с тегов HTML и вставляющий PHP только в случае необходимости? Или вам нужен только один раздел php, содержащий все?
2. Если у вас есть кусок кода PHP, в середине которого находится набор эхо-кодов, которые просто выводят фиксированный бит HTML, лучше ли вырваться из php и просто поместить HTML-код напрямую?
3. Должны ли все функции определяться в выделенных файлах php, или можно определить группу функций в верхней части файла и затем вызывать их в этом же файле?

Возможно, есть и другие вопросы, которые я хотел бы задать, но на самом деле я ищу кого-то, кто бы указал мне на какой-то ресурс в Интернете, который предлагает руководство по общей идее о том, как HTML и PHP должны объединяться вместе. *

Answer 1

Объединение программного кода и выходных данных (включая HTML) - ИМХО очень плохая идея. Большинство известных мне PHP-гуру используют движок шаблонов, такой как Smarty , чтобы разделить две вещи.

Answer 2

На самом деле нет единого, общего стандарта для этих вещей. В этом смысле большинство языков более строгие, чем PHP.

В более поздние годы появилось много так называемых фреймворков, и среди прочего они определяют набор правил для всего: от наименования места размещения файлов и стиля, которому должен следовать ваш код. Есть несколько рамок вокруг, так что вы не можете выбрать одну и назвать ее стандартной. Тем не менее, большинство структур имеют подмножество общности. Например, большинство следует некоторому варианту Стандартов кодирования PEAR .

Answer 3

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

Серьезно - вы должны попытаться следовать шаблону MVC в любом веб-приложении, поскольку это довольно стандартная практика независимо от языка. В PHP это может быть достигнуто быстрым и грязным способом, рассматривая index.php как ваш контроллер и разделяя логику данных и представление по файлам. Этот небольшой шаг, по крайней мере, позволит вам переместить ваш код в полнофункциональный фреймворк, когда и если вы выберете.

Answer 4

Используйте движок шаблонов, когда можете. Если вы его не изучили или не хотите накладных расходов (которые минимальны), используйте методы, которые заставляют вас быстро и грязно шаблонизировать:

• Функции, которые ничего не отображают, не помещаются в файл, который что-то отображает.
• Печать переменных, а не HTML. Всякий раз, когда выводите HTML, выходите из PHP и пишите HTML с помощью операторов print, чтобы обработать любые мелкие детали, которые необходимы (действия для форм, идентификаторы для элементов управления и т. Д.).
• Помните, что когда вы включаете файл, который выходит из PHP, для печати контента, он будет обрабатываться так же, как если бы вы делали это в основном файле. Таким образом, вы можете создавать простые шаблоны, которые просто включают файлы PHP, эти файлы будут печатать переменные в нужных местах. Ваш index.php (или любой другой) выполняет всю реальную работу, но все отображение выполняется вторичным «шаблоном».

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

Answer 5

Стандарты кодирования должны быть чем-то большим, чем компоновка синтаксиса, но, к сожалению, это то, чем они обычно бывают в PHP.

FWIW, phc будет довольно печатать ваш код в стиле Zend.

Answer 6

WHAT ARE CODING STANDARDS?

Coding standards (also sometimes known as ‘Coding Conventions’ or ‘Coding 
Rules’) are a set of guidelines that a group of developers stick to, to ensure 
that they are all essentially “singing from the same hymn sheet”. It means 
that they all code in the same format and therefore, regardless of who is next 
to work on a particular bit of code, the syntax and formatting used will be 
instantly familiar.
Naming conventions

Использование надлежащих соглашений об именах считается хорошей практикой. Иногда программисты склонны использовать X1, Y1 и т. Д. В качестве переменных и забывают заменить их на значимые, что вызывает путаницу.

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

Пример. Переменная для определения веса в качестве параметра для грузовика может называться TrkWeight или TruckWeightKilograms, причем TruckWeightKilograms является более предпочтительной, поскольку она распознается мгновенно. Смотрите CamelCase именование переменных.