Очистка фрагмента кода PHP

Зачем помогает форматирование

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

До и после

Исходный код, скопированный из лога:

<?php function total($items){$sum=0;foreach($items as $item){$sum+=$item["price"];}return $sum;}

Очищенный код с 4 пробелами:

<?php function total($items)
{
    $sum=0;
    foreach($items as $item)
    {
        $sum+=$item["price"];
    }
    return $sum;
}

Короткий чек-лист перед публикацией

• Удалите секреты. Текст, который вы вставляете сюда, обрабатывается на нашем сервере, поэтому не используйте настоящие учетные данные, токены или данные клиентов.
• Оставьте пример минимальным, только с теми строками, которые нужны для демонстрации проблемы.
• Укажите, какую версию PHP вы используете и что вы ожидали увидеть.
• Сравните отформатированный код с исходным. Инструмент меняет только разметку, но на комментарии и строковые литералы могут влиять правила пробелов.
• Поместите результат в блок кода, чтобы сохранились отступы.

Чем этот инструмент не является

Он не находит ошибки, не запускает код и не проверяет правила стиля. Аккуратная разметка облегчает заметить проблему, но не исправляет ее.

Где это помогает

• Обращение в поддержку или отчет об ошибке, в которые вложен пример кода.
• Вопрос на форуме разработчиков или в чате.
• Страница документации или руководство, где пример должен выглядеть аккуратно.
• Комментарий при рецензировании, в котором вы предлагаете изменить часть функции.

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

Сохраняйте пример достоверным

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