Я знал эту теорию.
Проверка кода помогает:
- Найти ошибки
- Убедитесь, что код читается и поддерживается
- Распространение знаний кода среди всей команды
- Ускорьте работу новых членов команды
- Покажите всем новые подходы к решению проблем
По крайней мере, таково было мое первое впечатление от обзора кода.
Я недавно закончил выпускной и занимался разработкой плагинов для компании-разработчика программного обеспечения в Лондоне.
Через некоторое время мне пришлось предоставить блоки идентичного или похожего кода.
Их пришлось просмотреть бедняге («Он лучший в этом деле», - сказал мой менеджер.
Ни одного доброго дела.
( не остается безнаказанным ) Однако каждый обзор приносил что-то новое.
Это казалось излишне придирчивым и случайным процессом.
Хуже того, проверки кода затянулись на дни, если не недели.
Когда я получил код обратно, я едва мог вспомнить, как я его написал.
Это была не вина того парня.
Он просил разработчика старшего уровня, но он меня нашел.
Ему надоели ошибки, допущенные неопытными разработчиками, и обзоры кода были способом облегчить это разочарование.
Добавьте к этому потери времени на синхронизацию веток, переключение между контекстами.
Я не был фанатом этого, да и остальные члены команды, как оказалось, тоже.
Забегая на несколько лет вперед, я соглашаюсь с твитом Джеффа Твуда:
«Коллегиальные проверки кода — это максимум, что вы можете сделать для улучшения своего кода».Когда я оцениваю прошедшие годы, я понимаю, что плохими были не ревью кода.
Проверка кода была проведена плохо.
И, черт возьми, мы сделали это плохо.
Я усвоил это на собственном горьком опыте.
И, конечно, понимание приходит не мгновенно.
Лишь спустя некоторое время я понял, что обзоры кода спасли меня от более чем неуклюжих и разрушающих сборку изменений! Но поработав в других местах, я приобрел опыт других, более эффективных способов работы.
Это дало мне возможность непосредственно увидеть преимущества проверок кода, которые я раньше не осознавал.
Так что теперь я считаю себя исправившимся скептиком.
Так вы сможете избежать таких болей: посмотрите наше видео а затем прочтите советы, которые помогут вам приблизиться к эффективным проверкам кода.
9 советов по поводу отзывов
Для всех:
- Просматривайте только то, что важно, а инструменты сделают все остальное
Вам не придется спорить о форматировании и стиле кода.
Существует множество инструментов, которые последовательно решают эти проблемы.
Важно, чтобы код был корректным, понятным и поддерживаемым.
Конечно, стиль и форматирование являются частью этого, но вы должны позволить инструментам проверять эти вещи.
- Каждый должен просмотреть код
Некоторые люди справляются с этим лучше, чем другие.
Более опытный человек вполне может найти больше ошибок, и это важно.
Но что более важно, так это поддерживать позитивное отношение к проверке кода в целом, и это позволит избежать отношения «мы против них» или той проверки кода, которая обременительна для всех.
- Посмотреть весь код
Ни один код не является слишком коротким или слишком простым.
Если просмотреть все, ничего не пропадет. Более того, это делает обзор частью процесса, привычкой, а не требованием.
- Примите позитивный настрой
Это важно как для рецензентов, так и для авторов кода.
Проверка кода — не время получать все пятерки и влиять на свое мастерство кодирования.
Вам не нужно защищаться.
Подходите к отзывам с позитивным настроем и конструктивной критикой, и вы сможете завоевать доверие в этом процессе.
Для рецензентов:
- Проверка кода должна проводиться часто и короткими сеансами.
Эффективность ваших обзоров снижается примерно через час.
Так что откладывание проверок и рассмотрение их всех за один большой сеанс никому не поможет. Найдите время в течение дня, совпадающее с перерывами, чтобы поддерживать поток и сформировать привычку.
Ваши коллеги будут вам за это благодарны.
Ожидание может быть утомительным, и они смогут быстрее решать проблемы, пока код еще свеж в их памяти.
- Можно сказать «все в порядке»
Не будьте придирчивы, не нужно искать проблему в каждом обзоре.
- Используйте контрольный список Контрольные списки Обзоры кода обеспечивают последовательность — они гарантируют, что все отслеживают важные и распространенные ошибки.
Для авторов кода:
- Код должен быть коротким
После 200 строк кода эффективность кода существенно падает. К тому времени, как вы прочтете 400 строк, они станут почти бессмысленными.
- Предоставьте контекст
Пожалуйста, предоставьте ссылки на любые соответствующие билеты или спецификации.
Есть инструменты для проверок кода, таких как Kiln, которые помогут в этом.
Дайте короткие, но полезные сообщения о коммитах и побольше комментариев в коде.
Это поможет рецензенту и у вас будет меньше вопросов.
Зарегистрируйтесь сейчас на вебинар «Проверка кода с помощью Kiln»
Присоединяйтесь к нам для нашего следующего онлайн-вебинара.Это поможет новичкам изучить основы проверки кода в нашем продукте.
Мы обсудим:
- Что такое проверка кода
- Зачем использовать проверку кода
- Когда его использовать
- Что смотреть во время обзора
- Создание обзора
- Просмотр комментариев и ответов на них
- Работа с существующими отзывами
- Процесс проверки кода
Примечание переводчика Текст во многом представляет собой рекламу продукта от FogCreek и их вебинаров.
Но текст о код-ревью не привязан ни к продукту, ни к рабочему процессу, который они предлагают. Какой бы инструмент вы ни использовали, советы по отзывам останутся актуальными.
И возможно они будут кому-то полезны.
Буду рад увидеть комментарии по улучшению перевода в личном сообщении, а по тексту - в комментариях к посту.
Теги: #codereview #code review #организация процессов #разработка веб-сайтов #программирование
-
Советы По Windows
19 Oct, 24 -
11 Вещей, Которые Я Узнал О Custdev
19 Oct, 24 -
Как Я Ходил В Облака
19 Oct, 24 -
Шифрование Rsa Для Первокурсников
19 Oct, 24 -
Командуй И Властвуй 3
19 Oct, 24
