Именование — Основы PHP

Именование переменных
Именование функций
Магические числа

Именование

В этом уроке мы поговорим об именовании. Изучать эту тему мы начнем с примера. Посмотрим на такую программу:

<?php

$x = 'Father!';
print_r($x);
print_r($x);

Она работает, но в ней странное имя переменной — $x. Компьютеру без разницы, как мы называем переменные, но вот программистам — нет. Мы гораздо реже пишем код, чем его читаем. Причем часто приходится читать не свой код, а написанный другими людьми. От качества и понятности имен переменных зависит половина успеха в анализе кода.

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

Среди разработчиков есть шутка: «самое сложное в программировании — названия переменных и инвалидация кеша». Придумывать названия и правда сложно. Например, какое бы название вы бы выбрали для переменной, в которой хранится количество неоплаченных заказов от клиентов, имеющих задолженность в предыдущем квартале?

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

Именование переменных

Некоторые имена довольно просты — например, $greeting. Но часто все не так очевидно. Довольно часто имена составные, то есть включают в себя несколько слов. Например, «имя пользователя». В разных языках применяются разные стили кодирования, и имя переменной будет отличаться.

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

kebab-case — составные части переменной разделяются дефисом (my-super-var)
snake_case — для разделения используется подчеркивание (my_super_var)
CamelCase — каждое слово в переменной пишется с заглавной буквы (MySuperVar)
lowerCamelCase — каждое слово в переменной пишется с заглавной буквы, кроме первого (mySuperVar)

В PHP используется CamelCase и его вариация lowerCamelCase, при котором первая буква первого слова — строчная. Именно lowerCamelCase применяется для переменных. Это значит, что имена соединяются друг с другом, при этом все имена кроме первого становятся с заглавной буквы: $userName. С тремя словами это выглядит так: $mySuperVariable.

Другое общепринятое правило гласит — не используйте транслит для имен, только английский язык. Если вы испытываете сложности с английским, то пользуйтесь переводчиком. Со временем, копаясь в чужом коде, вы сформируете правильные представления об именовании.

Названия должны не только передавать смысл, но и соответствовать синтаксическим правилам, которые обычно никак не проверяются на уровне языка, но нужны во время разработки. Процесс написания программ в современном мире — коллективная работа, и для лучшего взаимодействия в команде код пишется в едином стиле, как если бы над ним работал один человек.

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

К счастью, сегодня не нужно помнить все правила из стандарта, потому что существуют специальные программы, которые проверяют код автоматически и сообщают о нарушениях. Такие программы называются линтерами, и вы начнете их использовать немного позже, когда у вас появится чуть больше опыта.

Именование функций

Стиль именования функций в PHP такой же, как и стиль именования переменных: lowerCamelCase. Но при выборе самих слов есть важное отличие.

В большинстве случаев, функция — это действие. Вызов функции всегда подобен указанию «сходи», «возьми», «напечатай», «положи» и так далее. Вспомните, какие функции были в предыдущих уроках:

showDate («показать дату»)
sub (subtract — «вычесть»)
print_r («напечатать»)
round («округлить»)
gettype («получить тип»)

В отличие от функции, переменная — сущность. Поэтому мы используем существительные:

$child («ребенок»)
$result («результат»)
$euros («евро»)

Берите на вооружение следующую структуру: функция — глагол, переменная — существительное.

Жизнь программиста наполнена такими моментами, в которые нужно открыть старый код и попытаться понять его. Чтобы вам и вашим коллегам было удобнее, давайте переменным и функциям понятные названия.

Магические числа

Посмотрим еще раз на код:

<?php

$eurosCount = 1000;
$dollarsCount = $eurosCount * 1.25; // 1250
$rublesCount = $dollarsCount * 60;  // 75000

print_r($rublesCount);

С точки зрения профессиональной разработки, такой код не соответствует лучшим практикам (best practices).

Уже сейчас, глядя на числа 60 и 1.25, вы скорее всего задаетесь вопросом: «Что это за числа?». Если человек видит код в первый раз, он не поймет, откуда числа взялись. В нашем примере контекст восстанавливается благодаря грамотному именованию, но в реальной жизни код значительно сложнее, и поэтому догадаться до смысла чисел зачастую невозможно.

Эту проблему вызывают магические числа (magic numbers). Так называют числа, происхождение которых невозможно понять без глубокого знания этого кода.

Выход из ситуации прост — достаточно создать переменные с правильными именами, и так все встанет на свои места:

<?php

$dollarsPerEuro = 1.25;
$rublesPerDollar = 60;

$eurosCount = 1000;
$dollarsCount = $eurosCount * $dollarsPerEuro;   // 1250
$rublesCount = $dollarsCount * $rublesPerDollar; // 75000

print_r($rublesCount);

Обратите внимание на следующие детали в этом примере:

Мы использовали именование lowerCamelCase
Две новые переменные отделены от последующих вычислений пустой строчкой. Эти переменные имеют смысл и без вычислений, поэтому такое отделение уместно, оно повышает читаемость

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