Ответы пользователя по тегу Laravel
  • Попросили проверить код, на что смотреть нужно?

    @kalyabus
    Сначала поймите зачем нужно "проверить" код, потом поймете, "что" проверять. Тем не менее приведу выжимку из критериев, принятых у нас

    1. Код не содержит явных и потенциальных ошибок.
    2. Код работает так, как это описано в документации, техническом задании или сопроводительных комментариях.
    3. Стиль кодирования соответствует принятым правилам кодирования
    4. Код имеет сопроводительные комментарии в соответствии с phpDoc
    5. Вложенность блоков не превышает 4-го уровня.
    6. Код не генерирует сообщения уровня Strict, Warning, Notice, Deprecated. Если этого невозможно избежать, то непосредственно перед строкой, которая это генерирует необходимо принудительно отключить error_reporting, а непосредственно после строки включить error_reporting в исходное значение (которое было до этого). Такой код должен быть задокументирован специальным образом.
    7. Закомментированный кусок кода должен быть удален.
    8. В PHP коде (за исключением phpTemplate) запрещены вставки HTML, JavaScript. Все вставки должны производиться через специальные шаблоны.
    9. Классы, функции, переменные и константы должны логически именоваться человекопонятным способом на английском языке в соответствии со стандартами кодирования. Не допускается именование транслитом на русском, либо на иных языках
    10. Область видимости переменных и методов классов всегда должна быть определена (private, protected, public).
    11. Размер одного метода не должен превышать 40-50 строк.
    12. Переменная, используемая в цикле, либо в условном блоке должна быть инициализирована заранее.
    13. Переменная в любой момент времени должна содержать только один тип. Пустая переменная должна содержать null. (не допускается $var = false; $var = 'test'; . Допускается $var = null; $var = 'test';).
    14. При передаче объектов классов в методы должен использоваться контроль типов.
    15. etc...


    Список далеко не полный. Все зависит от проекта, выполняемой задачи, платформы и компетенции команды. Зачастую просят проверить код перед приемкой на сопровождение. Декларируйте какой-то свой свод правил кодирования и отталкивайтесь от него.

    PHP, к сожалению (а может и к счастью), не строгий язык...
    Ответ написан