Вся цель этой серии — раскрыть стандарты кодирования WordPress , почему они важны и как писать качественный код WordPress. Для этого мы подробно рассмотрим каждый раздел стандартов кодирования WordPress.
Итак, мы рассмотрели:
- Соглашения об именах и аргументы функций
- Одинарные и двойные кавычки
Сегодня мы рассмотрим важность пробелов. В частности, мы собираемся охватить отступы, использование пространства и конечные пробелы. Как бы легко это ни звучало, это несколько наиболее игнорируемых или неправильно используемых аспектов стандартов кодирования.
Слово о пустом месте
Прежде чем мы рассмотрим, что происходит с различными стандартами кодирования, важно понять, почему пробелы важны не только в WordPress, но и в языках программирования в целом.
Проще говоря, это потому, что это улучшает читабельность.
Вот почему некоторые языки программирования разделяются пробелами или табуляцией, поэтому некоторые языки программирования требуют, чтобы вы выделяли определенные части кода, такие как параметры функций, индексы массивов и многое другое.
Когда речь заходит о WordPress, существуют соглашения не только для удобства чтения, но и для обеспечения единообразного чтения и разработки для всех, кто работает над темами WordPress, плагинами, приложениями или самим основным приложением.
Помните: цель стандартов кодирования — сделать так, чтобы исходный код выглядел так, как будто он написан одним разработчиком, поскольку он устанавливает уровень ожиданий для разработчиков.
вдавливание
Что касается отступов, нет ничего особенно нового, революционного или отличного в том, что касается WordPress. Вообще говоря, вы будете делать отступы каждый раз, когда начинаете новый блок.
Это означает, что:
- Ваши функции будут с отступом в классе
- Ваши условные обозначения и переключатели / кейсы и другие блоки будут выделены в пределах их функций
- Ваши циклы будут иметь отступ в своих функциях, в своих условных выражениях и т. Д.
Если вы привыкли писать код на языках стиля C, то здесь нет ничего особенно нового, верно?
Пример того, как это может выглядеть, выглядит следующим образом:
|
01
02
03
04
05
06
07
08
09
10
11
|
function foo( $arguments ) {
if ( 0 < count( $arguments ) {
foreach ( $arguments as $arg => $value ) {
echo $value;
}
}
}
|
Согласно стандартам кодирования:
Ваш отступ всегда должен отражать логическую структуру. Используйте реальные вкладки, а не пробелы , поскольку это обеспечивает наибольшую гибкость для клиентов.
Ключевым моментом является то, что начало строк должно начинаться с вкладок, а код должен отражать логическую структуру. Не переусердствуйте и не пытайтесь упрощать вещи.
Есть еще один нюанс с пробелами в стандартах кодирования WordPress: вкладки должны использоваться в начале строки, но пробелы должны использоваться везде. По большей части, это простое правило для подражания; однако в WordPress вы часто будете создавать массивы для передачи в качестве аргументов.
В идеале мы хотим, чтобы каждый индекс массива выстраивался в линию так, чтобы читаемость была как можно выше, но у нас часто есть склонность использовать вкладки, чтобы упростить их выстраивание, но это на самом деле является нарушением стандартов кодирования.
|
1
2
3
4
5
|
$args = array(
‘ID’ => 1,
‘post_title’ => ‘The Title’,
‘post_content’ => ‘The content’
);
|
Поэтому убедитесь, что вы используете только вкладки в начале каждой строки.
Космическое использование
Что касается WordPress, я обнаружил, что пробелы используются гораздо более свободно, чем в других языках. Я не говорю это просто как наблюдение, поскольку это была личная корректировка, которую мне нужно было сделать, исходя из .NET и Ruby.
Тем не менее, как и в большинстве других руководящих принципов Кодекса, нет ничего особенно сложного; Тем не менее, при написании кода необходимо помнить о некоторых важных различиях.
Пробелы следует размещать в следующих местах:
- После запятых
- По обе стороны логических операторов (то есть,
||,&&и!) - С обеих сторон операторов сравнения (то есть
<,>,==,===и т. Д.) - По обе стороны от операторов присваивания (а именно
=) - С обеих сторон открывающая и закрывающая скобки функций, условных выражений, циклов и т. Д.
- Когда переменная передается как индекс массива, но не когда литеральное значение (например, строка или целое число)
Большинство из них относительно просты, но по своему опыту я обнаружил, что правила для массивов, как правило, вызывают наибольшую путаницу среди разработчиков, поэтому вот краткое замечание о том, что считается правильным, а что нет:
|
1
2
3
4
5
6
7
|
// Correct spacing…
$arr[ $x ] = ‘foo’;
$arr[0] = ‘bar’;
// Incorrect spacing…
$arr[$x] = ‘bar’;
$arr[ 0 ] = ‘bar’;
|
Как видите, ничего страшного в этом нет, но пропустить его относительно просто.
Конечные пробелы
Это правило, вероятно, самый простой стандарт, чтобы помнить их всех Проще говоря, в конце строки кода не должно быть пробелов.
В зависимости от вашей IDE этот фильтр может быть встроен; в других случаях вам может понадобиться установить плагин, который будет выполнять это действие при каждом сохранении файла. Но в любом случае это относительно простая функция для интеграции в любую IDE, которую вы используете.
Кроме того, в большинстве редакторов — независимо от того, является ли это прославленным текстовым редактором или полной версией IDE — у вас должна быть возможность включать отображение вкладок и пробелов.
Опять же, это одно из самых простых соглашений, которым нужно следовать, и вполне вероятно, что ваша IDE или редактор по вашему выбору имеет эту функцию или плагин, который позволит вам автоматически делать это.
Если нет, вы сможете активировать возможность видеть вкладки, пробелы, возврат каретки и т. Д., Чтобы вы могли легко определить, где находятся пробелы в конце.
Вывод
Очевидно, что пробел играет важную роль в написании кода на основе WordPress. В этой статье мы рассмотрели отступы, табуляции, пробелы, завершающие пробелы, а также почему и как включить их в наши проекты.
В следующей статье мы продолжим разговор о тонкостях стандартов кодирования WordPress, рассмотрев стиль скобок, регулярные выражения и нюансы использования тегов PHP через наш код WordPress.