Вернуться назад

Как правильно провести код ревью?

Программирование Ответов: 1
Alma
Пользователь
ALMAMAT

Тема код-ревью – объемная. По идее, нужно отдать фрагмент кода на проверку более опытному разработчику в команде, чтобы он оценил его, в том числе по гайдлайнам, оперативно дал комментарии – и принял или отклонил. Фрагмент кода, который проходит код-ревью, в гайдлайнах Google называют CL (changelist), а на практике часто MR (мердж-реквест, merge request) или PR (пулл-реквест, pull request). Рассматриваемый код должен быть не только качественным сам по себе, но и улучшать базу кода. Пример, сам код хороший, но привносит изменение, которое системе не нужно, – тогда его не принимают. При этом код не обязан быть идеальным. Для несущественных замечаний делают пометку в комментариях. В ходе код-ревью ищут возможности улучшить код, руководствуясь стайл-гайдом и принципами создания софта. Качество код-ревью зависит от опытности ревьюера. Если код-ревьюер и автор кода в чем-то не согласны, они обсуждают проблемные места в комментариях и лично, иногда с командой и старшим разработчиком, принимающим решение.

Код-ревью позволяет улучшать качество кода, а значит и продуктов. В технологических компаниях есть лучшие практики и гайдлайны, они доступны публично. Существует, например, гугловский "Code Review Developer Guide", то есть «Гид по проведению код-ревью для девелоперов». Там есть полезные вопросы.

Дизайн: хорошо ли устроен код сам по себе и для проектируемой системы?
Функциональность: код ведет себя так, как задумывал автор? А для пользователей хорошо, что код ведет себя так?
Сложность: можно ли написать код для этой задачи проще? Другой разработчик сможет легко понять и использовать его, когда столкнется с ним в будущем.
Тесты: для этого кода написаны корректные и грамотно спроектированные автоматические тесты?
Нейминг: разработчик использовал понятные названия для переменных, классов, методов и др.?
Комментарии: они ясные и полезные?
Стиль: код соответствует стайл-гайдам?
Документация: разработчик обновляет соответствующую документацию?

Что делать начинающим кодерам, которые пишут личный проект для портфолио и готовятся в поиску работы? Если старших коллег или знакомых опытных программистов пока нет, то можно выложить фрагмент кода на Github и попросить пользователей оценить, посмотреть ошибки. Такой неформальный код-ревью отличается от канона по форме, но это ценный инструмент для совершенствования. Если автор кода знает гайдлайны, он сможет лучше понять логику ответов и задать вопросы. В любом случае будет выполнено требование – код должен посмотреть другой программист, желательно более опытный. Блог Almamat еще остановится на теме код-ревью, там много нюансов.

0
Войди в IT с программой
#Tech_for_all
Записаться на программу