При проведении код-ревью стоит обратить внимание на следующие аспекты:
- Задача, которую решал автор кода. 1 Для этого нужно посмотреть техническое задание и уточнить детали у разработчика. 1
- Архитектура кода. 1 Нужно оценить, грамотно ли он написан. 1
- Функции и отдельные алгоритмы. 1 Следует посмотреть на их эффективность и проверить, можно ли заменить их другими методами и будет ли это лучше для всего продукта. 1
- Читаемость кода. 4 Нужно оценить ясность и краткость кода, соблюдение языковых и проектных соглашений. 4 Если код запутан или не структурирован, следует предложить его разделить и переорганизовать. 4
- Наличие уязвимостей в системе безопасности. 2 Стоит проверить, не используются ли в коде устаревшие инструменты или инструменты с известными проблемами безопасности. 2
- Скорость и производительность. 2 Нужно сопоставить потребление ресурсов программой с её скоростью. 2 Например, содержит ли код неэффективные конкатенации строк, ведение журнала или присвоения объектов. 2
- Тесты. 4 Автоматизированные тесты — это тоже код, поэтому их тоже нужно проверять. 4 Важно оценить качество этих тестов, что и как они тестируют, их читаемость, правильность именования и покрытие кода тестами. 4
Выбор, на что смотреть при проведении код-ревью, зависит от конкретной задачи и целей проверки. 5