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

Здравствуйте, будущие разработчики PHP! Я рад помочь вам окунуться в fascинирующий мир стандартов кодирования на PHP. Как alguien, кто уже давно teaches программированию, я могу assure вас, что овладение этими стандартами сделает ваш код чище, более читаемым и профессионнальным. Давайте погрузимся!

Отступы и длина строк

Правильные отступы в коде - это как good manners в программировании - они делают все более приятным и легким для понимания. В PHP мы обычно используем 4 пробела для каждого уровня отступа. Вот пример:

<?php
if ($condition) {
echo "Эта строка отступлена";
if ($another_condition) {
echo "Эта строка отступлена еще больше";
}
}

В этом примере первое предложение echo отступлено один раз (4 пробела), а второе echo отступлено дважды (8 пробелов). Эта визуальная иерархия помогает нам быстро понять структуру кода.

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

$very_long_variable_name = $another_long_variable_name
+ $yet_another_long_variable_name
+ $one_more_long_variable_name;

Структуры управления

Структуры управления - это строительные блоки логики вашей программы. В PHP最常见的 из них - if, else, elseif, while, for и switch. Вот как правильно их форматировать:

if ($condition1) {
// код здесь
} elseif ($condition2) {
// больший код здесь
} else {
// еще больший код здесь
}

while ($condition) {
// код для повторения
}

for ($i = 0; $i < 10; $i++) {
// код для повторения
}

switch ($variable) {
case 1:
// код для case 1
break;
case 2:
// код для case 2
break;
default:
// код по умолчанию
break;
}

Обратите внимание, как каждый блок кода заключен в фигурные скобки {} и правильно отступлен.

Вызов функций

При вызове функций не должно быть пробела между именем функции и открывающей скобкой. Вот правильный способ:

$result = myFunction($arg1, $arg2);

Если вызов функции слишком долог, вы можете разбить его на несколько строк:

$result = myVeryLongFunctionName(
$arg1,
$arg2,
$arg3,
$arg4
);

Определения функций

При определении функций следуйте этому формату:

function myFunction($arg1, $arg2 = null)
{
// тело функции
}

Обратите внимание, что открывающая скобка { находится на новой строке. Это называется "стиль Allman" и является.common в PHP.

Комментарии

Комментарии имеют решающее значение для explanations вашего кода. Используйте их щедро! Вот типы комментариев в PHP:

// Это комментарий одной строки

/*
Это комментарий многострочный.
Он может занимать несколько строк.
*/

/**
* Это комментарий DocBlock.
* Он используется для документирования функций, классов и т.д.
*
* @param string $arg1 Описание первого аргумента
* @return bool Описание того, что возвращает функция
*/
function myDocumentedFunction($arg1)
{
// тело функции
}

PHP теги

При записи PHP кода всегда используйте полные PHP теги:

<?php
// Ваш PHP код здесь
?>

Избегайте использования коротких тегов, таких как <?, так как они не всегда включены на всех серверах.

Имена переменных

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

$user_name = "John";
$total_items = 5;

Для констант используйте все прописные буквы с подчеркиваниями:

define('MAX_USERS', 100);

Делайте функции рекурсивными

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

// Не рекурсивно
function badCounter()
{
static $count = 0;
return ++$count;
}

// Рекурсивно
function goodCounter($count)
{
return ++$count;
}

Выравнивание блоков объявлений

При объявлении нескольких переменных выравнивайте их для лучшей читаемости:

$short        = 1;
$long_variable = 2;
$longer_variable = 3;

Один оператор на строку

Для clarity,.put только один оператор на строку:

$a = 1;
$b = 2;
$c = 3;

Избегайте:

$a = 1; $b = 2; $c = 3; // Это сложнее читать

Короткие методы или функции

Держите свои функции короткими и сосредоточенными на одной задаче. Как rule of thumb, если функция длиннее 20-30 строк, рассмотрите возможность разбиения ее на более мелкие функции.

Вот таблица, резюмирующая некоторые из ключевых стандартов кодирования PHP, о которых мы говорили:

Стандарт	Пример
Отступы	Используйте 4 пробела
Длина строки	Держите менее 80 символов
Вызов функций	myFunction($arg1, $arg2);
Определения функций	function myFunction($arg1, $arg2) { ... }
Имена переменных	Используйте snake_case: $user_name
Константы	Используйте ВЕРХНИЙ РЕГИСТР: MAX_USERS
Комментарии	Используйте //, /* */, или /** */
PHP Теги	Всегда используйте <?php ?>

Помните, эти стандарты не являются произвольными правилами. Они - наилучшие практики, разработанные на протяжении многих лет сообществом PHP, чтобы сделать код более читаемым и maintainable. Следуя этим стандартам, вы не просто пишете код - вы общаетесь с другими разработчиками, которые могут работать с вашим кодом в будущем. И кто знает? Этот будущий разработчик может быть вы!

Заканчивая, я вспоминаю студента, который однажды сказал мне: "Изучение стандартов кодирования похоже на изучение этикета за столом. Сначала это seems fussy, но как только вы привыкните, вы удивляетесь, как вы жили без этого!" Так что продолжайте практиковать эти стандарты, и вскоре они станут второй naturой. Счастливого кодирования!

Credits: Image by storyset