Привет, Хабр! Представляю вашему вниманию перевод статьи «6 советов по успешному обзору кода» .
Обзор кода всегда был фундаментальной практикой, ответственной за создание чистого и удобного в сопровождении кода.
Зачастую разработчики пренебрегают и недооценивают проверку кода по причинам, которые на тот момент кажутся объективно правильными.
Давайте сформулируем сегодня 6 советов, как провести качественный и плодотворный код-ревью .
Я – Выбери правильный момент
Проведение проверки кода начинается с выбора подходящий момент .Попробуем описать его характеристики:
- Низкий шанс быть прерванным : Вам следует избегать рабочего времени, в течение которого, как показывает опыт, люди склонны отвлекаться от рабочего процесса.
Ведь в некоторые дни часто бывают периоды затишья, и именно в такие моменты стоит запланировать код-ревью.
- Чистый и ясный ум : Вы не должны испытывать стресс перед проверкой и во время процесса, например, опасаясь предстоящей встречи с заказчиком.
Также программист, код которого подлежит ревью, должен находиться в спокойном состоянии, чтобы между вами не возникло напряжения, которое могло бы испортить процесс ревью кода.
- Разработчик гарантирует, что код готов к проверке.
: Нет смысла тратить время на просмотр того, что еще не готово.Под готовностью мы подразумеваем, что код работает, без плохих практик, документирован и как минимум покрыт модульными тестами.
По опыту, если разработчик сам уделяет время проверке кода, он с большей вероятностью отправит на проверку код, за который ему не стыдно.
II – Установите границы
Стоит заранее понимать будущие масштабы проверки кода.
Рассмотрим одну или несколько особенностей? Учитывая время, есть ли смысл думать слишком много?Обычно вы хотите сосредоточиться на ограниченном количестве изменений, чтобы лучше понять, о чем они, и не слишком часто переключаться между фрагментами кода.
Чтобы правильно установить границы задачи, вы можете:
- Выполнять поставленные задачи предсказуемого размера .
Для этого разделите большие задачи на маленькие и атомарные, например, в Jira или даже на классической Scrum-доске.
- Правильно расставляйте приоритеты проверок кода : Если задач, ожидающих рассмотрения, слишком много, вы не сможете просмотреть все.
Выбирайте приоритетные.
III – Создайте правильную атмосферу
Прежде чем приступить к ревью кода, создайте вокруг себя благоприятную атмосферу.Что для этого потребуется?
- Минимальное количество посторонних звуков : Вы будете более продуктивны, если вокруг вас будет как можно меньше шума.
Ведь чем его меньше, тем лучше концентрация.
- Нет зоны «прерывания» : аналогично тому, что было описано в первой части, следует избегать моментов, когда их можно оторвать от процесса.
Проще это сделать в отдельной комнате.
- Зона позитивной критики : Критика чужого творчества – сложный процесс.
Но еще сложнее это сделать, когда вокруг много людей.
В закрытом помещении можно свободно говорить, не опасаясь, что вас подслушают.
IV – Общайтесь, общайтесь и еще раз общайтесь.
Проверка кода — это не односторонний процесс.
Успешная проверка кода во многом зависит от умения уважительно и эффективно общаться с коллегой.
Ведь не только инспектор заявляет, что правильно, а что нет. Проверка кода — это разговор обо всем: объеме, намерениях, исправлениях и даже разногласиях.
В процессе старайтесь придерживаться следующих рекомендаций:
- Не просто слушать, а слышать : Мнения и взгляды часто расходятся, и каждое разногласие обязательно порождает конструктивное обсуждение вопроса.
Каждая точка зрения требует внимания.
- Нейтральный тон : Code review — это не экзамен и не инквизиция.
Создайте ощущение, что вы пришли судить код, а не человека, который его написал.
- Если у вас есть сомнения, пожалуйста, уточните : Если вы не уверены в конкретной детали реализации, спросите об этом.
Некоторые намерения, неочевидные на первый взгляд, часто впоследствии порождают неверные толкования.
V – Помните о конечной цели
Проверка кода должна привести к окончательному результату.результат : возможно конструктивная критика и советы по улучшению или интеграция кода с соответствующими ветвями разработки, выбранными в gitflow. Это обязанность рецензента.
Но как определить, можно ли интегрировать код?Вот несколько критериев, которые помогут вам принять решение:
- Написанный код решает проблему, описанную в утверждении.
- Код правильный покрыт модульными тестами .
- Конфликты слияния решены правильно.
- Никаких явных признаков запах кода или плохие практики .
VI – Используйте специальные инструменты
Есть инструменты для удобной проверки кода.Вы можете без колебаний использовать их, чтобы упростить процесс проверки кода и интеграции.
На рынке программного обеспечения для проверки кода лидируют три бренда: Smartbear (с соавтором) , Перфорс (с Helix Swarm) И Atlassian (с Crucible) Такие инструменты часто предоставляют обширные инструменты проверки кода, а также метрики, которые помогут вашей команде постоянно совершенствоваться.
Это нечто большее, чем просто инструменты сравнения кода, и они интегрируются практически со всеми доступными системы контроля версий .
Попробуй это!
Ваша очередь поделиться!
Если у вас есть дополнительные советы или конкретные примеры, которые случались с вами в повседневной жизни разработчика, поделитесь ими в комментариях.Теги: #программирование #Управление разработкой #Идеальный код #перевод #отладка #ревью кода
-
Amd Предоставила Новые Серверы Groklaw
19 Oct, 24
