Что такое Code Review

Понятие Code Review появилось в обиходе не так давно. Дословно, оно подразумевает проверку, инспектирование, обзор, коррекцию программного кода. Целью данной работы является нахождение нестыковок, отклонений, некорректного поведения ПО. Основной задачей проведения код ревью считается улучшение показателей программы. Code Review может быть проведен одним специалистом или группой разработчиков. Процесс проведения зависит от сложности поставленных задач и может проходить как чтение кода программы по основным точкам или, в виде совещания команды специалистов, с последующими выводами по произведенной работе. Хороший Code Review подразумевает не только поиск нестыковок, но и рекомендации по их устранению, совещание по этапам дальнейших действий.

Критерии хорошего кода

Разработчики, создающие программу, всегда понимают, как должен быть написан хороший код. Каждый специалист, работающий над новым сайтом или приложением, начинает процесс с создания качественной основы. Что подразумевается под качественным кодом? Главное – это простота и гибкость. Создать простой код сложно, это не означает упростить и сократить. Простой код – это максимальная ясность в процессе работы. Для определения качества исходного кодирования, существует несколько точек, по которым нужно ориентироваться:

• Простота восприятия кода. Хороший код не должен содержать множество запутанных конструкций. Специалист должен понять принцип кодирования без дополнительных пояснений и документов.
• Гибкость кода. Простой, но грамотно продуманный код, позволяет производить коррекцию и внесение изменений без потери качества. В случае хорошего исходного кода, в дальнейшем есть возможность изменения конфигурации.
• Возможность дополнения. Код должен позволять вносить новый функционал без опасения нарушения основных алгоритмов.
• Легкость эксплуатации. При возникновении каких-либо неполадок должна быть возможность быстрого решения.
• Доступность. Хороший код подразумевает, что при необходимости, его можно передать для дальнейшей работы другому специалисту. И новый разработчик сможет без труда разобраться в программе, внести изменения и добавить новые пункты.

Для того, чтобы облегчить процесс разработки нового кода, любой язык программирования включает свои стандарты. Стандарты code style подробно описывают процесс расстановки знаков, отделения конструкций, расстановки пробелов. Неопытные специалисты иногда игнорируют данные стандарты. Это не желательно, так как соблюдение правил, дает гарантии, что последующий работник сможет разобраться в программе.

Повышение качества кода

Для того чтобы повысить качество кодирования, создана техника Code Review. Проведение мероприятий по проверке кода повышает вероятность того, что изменения, планируемые разработчиком, будут отслежены и сохранены. Часть работ по проверке кода можно осуществлять в специальных программах - для обнаружения простых ошибок в расстановке пробелов или сделанных отступов, человек потратит гораздо больше времени, чем специализированная программа. В то же время живые люди должны сконцентрироваться непосредственно на логике программы. Когда в команде задействованы профильные сотрудники, они имеют собственный опыт и особое видение ситуации. Все это поможет создать по-настоящему качественный продукт.

Как происходит процесс оценки качества

После создания нового кода и перед тем, как внести изменения в программное обеспечение, сотрудник доносит предложение до стальных членов команды, производящих Code Review. Далее команда разбирается в смысле предложенных изменений и комментирует результат. Начинает команда с найденных багов, затем указывает структурные ошибки, возможное некорректное использование некоторых инструментов.

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

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

Преимущества и недостатки процесса проверки кода

Проверка в технике Code Review выявляет недочеты в разработанном коде на ранних этапах. Такая тактика дает возможность избежать внеплановых ситуаций и затрат в будущем. Можно определить еще несколько плюсов такого подхода:

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

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

Преимуществ использования Code Review намного больше, чем недостатков, но нужно понимать, что его применение не всегда актуально. Есть проекты, в которых нет необходимости в таком подходе. При создании стационарных программ, в которые не планируется вносить изменения, можно обойтись и без фиксации кода несколькими специалистами. Но если есть тенденция к добавке функционала, появлению новых возможностей в дальнейшем, тогда проводить Code Review необходимо. Если планируется большой, долгосрочный проект, всегда есть вероятность привлечения новых специалистов, увеличения аудитории, внедрения новых технологий. Тогда проведенная работа по проверке и оценке, поможет в дальнейшем избежать финансовых затрат, сделает работу быстрее, легче и качественнее. Поэтому многие компании сегодня делают Code Review обязательным пунктом при внесении программных изменений, даже при наличии опытного разработчика.