Как улучшить код?

Question

[asportan]

/**
     * Return full order info
     * @param Order $order
     * @return JsonResponse
     */
    private function returnFullOrderInfo(Order $order, $warning = null): JsonResponse
    {
        $result = $order->fullInfo();
        $result->warning = $warning;
        return $this->responseSuccess($result);
    }

Можно ли как-то улучшить этот код?

Comments

[Slava Rozhnev]

Зачем?

[asportan]

Slava Rozhnev, Выглядит криво)

[Радмир Ноирусов]

По-моему чёт это максимальное улучшения :)

[Ипатьев]

asportan, что именно?

[Vitsliputsli]

Удалите все и будет идеально.
Иначе, не совсем хорошо расписан phpdoc, плохо выбрано название, и т. д., и т. п. Конечно, все это так. Но работающий код гораздо эффективнее грёз об идеальном. Это не значит что нужно писать говно, просто находить баланс между сроками и требованиями, и кодом, который им удовлетворяет. Да, нужно правильно выбирать названия методам и переменным, но мы все не идеальны. Да, нужны проверки и защиты, но не всюду и везде.
Поэтому в отрыве от всего кода, вопрос бессмысленен.
Хотя вопрос есть, вы что phpdoc вручную писали? Есть же ide.

Answer 1

[Алексей Уколов]

Для начала можно удалить весь DocBlock. Во-первых, он не добавляет ровным счётом никакой информации, а во-вторых, ещё и не все параметры содержит.

Название returnFullOrderInfo можно переименовать в makeFullOrderInfoResponse - в названиях функций слово return не несёт ценности.

Метод fullInfo тоже можно переименовать в (to|make|get)FullInfo для того, чтобы по названию было понятно, что метод делает.

Метод responseSuccess тоже криво назван.

Почему у параметра $warning не указан тип?

Если $warning связан непосредственно с заказом, то его имеет смысл передавать в качестве аргумента в fullInfo, чтобы инкапсулировать и не менять объект снаружи. Если же не связан, то формат ответа лучше поменять на ['data' => $orderInfo, 'warning' => $warning].