Ури Шамай — близкий друг и Wunderkind с огромным опытом работы в области DevOps как в качестве основателя, так и застройщика для ряда организаций. Он написал отличный пост, детализируя некоторые из самых важных аспектов, которые необходимо запомнить при создании контрольного списка кода, и почему он так важен в цикле разработки.
Обзор кода — лучший способ поддерживать высокий уровень качества кода. Обзор кода выступает не только как привратник для плохого кода, но и как стимул для кодеров, чтобы улучшить свои навыки, учиться и изучать свою работу. Кодовые гиганты, такие как обзор кода использования Google, на все добавленные в кодовую базу.
Большинство кодеров не используют контрольный список. По крайней мере, не формализованный. И определенно не контрольный список в качестве инструмента, создаваемого командой или компанией, которая используется равномерноми всеми кодерами и рецензентами. Они могут использовать умственный контрольный список, который они создали для себя. Но этот контрольный список может иметь большие недостатки, если он не обсуждается, спроектирован и поддерживается несколькими людьми. Контролируемые списки Вы можете найти в Интернете слишком долго и слишком абстрактны для тех, кто на самом деле использовать. Вот почему, Если вы собираетесь использовать контрольный список, вы должны построить свой собственный Отказ
Зачем использовать контрольный список?
Обзоры кода должны создавать изменения. Если они этого не сделают, они также могут не случиться Отказ Это может привести к одному из крупнейших Ловушки кода Отзывы Отказ Впадение в сессию без надписи в поисках чего-то для изменения.
Используя контрольный список, рецензенты могут придерживаться того, что важно, и находят эти изменения в больших вещах. Контрольные списки также помогают рецензентам убедиться, что они не забывают ничего важного.
Когда вы должны использовать контрольный список просмотра кода?
А Контрольный список может быть инструментом Вы создаете, чтобы улучшить свои кодовые отзывы, или это может быть больше установленной общей практики общества Отказ В любом случае, контрольный список может использоваться как кодом, отправляющим код для проверки, так и для человека, выполняющего обзор.
Подготовка кода для просмотра — это важный шаг, и контрольный список позволяет кодеру сделать шаг назад и посмотреть на их код более объективно, прежде чем передавать код на рецензента . Я так пошел так далеко, чтобы сказать, что контрольный список может принести пользу кодеру больше, чем рецензента.
Лучшие советы по созданию эффективного контрольного списка обзора кода
1. Разум длина
При строительстве контрольного списка кода важно учитывать длину Отказ Если контрольный список слишком короткий, вряд ли будет настоящий контрольный список и охватывать важные вещи. Но если контрольный список слишком длинный? Это просто будет игнорировать, так как было бы слишком утомительно использовать.
Правильный размер для вашей команды не может быть таким же, как и для другого. Тем не мение, Как правило, 3-5 основных проблем, а еще 7-10 дополнительных записей или меньшего или меньших вопросов, будет бы порекомендовать.
2. Начать с основы
Там являются Многие код Обзор Контролировать там. Некоторые являются длинным списком вопросов, а некоторые являются широкими тем, которые вы должны обязательно коснуться. Большинство из этих вопросов — это просто хорошие принципы дизайна, любой кодер должен знать и управлять во время записи кода. Имеет смысл, что это будет фокус контрольных списков Отказ
Тем не менее, я считаю, что это бесполезно иметь элемент контрольного списка, который спрашивает, является ли рассматриваемый код хорошим дизайном. Вместо этого Я рекомендую в том числе предметы, которые поощряют сосредоточить внимание на причинах, по которым код был написан на первом месте, или придать различную линзу, через которую можно просмотреть код Отказ
3. Подготовьте свой код
До того, как вы даже получите какое-либо объяснение из кодировщика, спросите себя «Это код самоназначительной? «Я большой сторонник самодокументирующий код . Но Даже если ваш стиль кодирования включает комментарии, код должен быть читаемым человеком Отказ
Чтобы прочитать код без каких-либо объяснений, вызывает рецензента, чтобы убедиться, что они могут понять код без того, чтобы кто-то его объяснил. Если какая-либо часть кода требует объяснения, чтобы быть понятым, может быть лучше сломать его на меньшие кусочки кода или добавить комментарий Отказ С помощью этого элемента на контрольном списке рецензент может просто сказать кодиру, что они не поняли код. Кодер может уточнить, но они будут знать, что им нужно сделать код более четкой.
4. Affective VS эффективный код
Как только вы понимаете, что делает код, вы должны спросить: Изменение кода достигает своей цели просто и эффективно? Люди очень защиты их кодекса, и как таковой будет неохотно выбрасывать свою работу и найти другое решение. Но если вы можете предложить более эффективное изменение кода? Вы должны принести это на внимание кодер.
5. Общаться эффективно
Как вы общаетесь свое предложение в контрольном списке, очень важно, будет ли его принято . Мне лучше всего задавать руководящий вопрос и пусть разработчики придумывают альтернативные решения. Таким образом, это все еще их идею, и она будет встречаться с меньшим сопротивлением. Помните, Отзывы кода не показывать свой коллеги, насколько вы умны, речь идет о том, чтобы сделать код как можно лучше Отказ
6. Не пренебрегайте зависимостями
Часто упущенная часть обзора кода является зависимости . Легко упускать из виду новую зависимость или код в упаковке, в котором он не принадлежит. Положить этот предмет на контрольный список, гарантирует, что этот вопрос не пропущен Отказ Это также может сделать проверку кода быстрее, так как любые проблемы зависимости могут быть разрешены кодером перед отправкой кода для просмотра.
7. Рассмотреть вопрос о конкретных компаниях
Я мог бы продолжать и перечислить бесконечное количество проблем, которые могут или не могут применяться к вашей конкретной кодовой базе. В конце дня ваш контрольный список должен быть адаптирован для ваших нужд Отказ
Ваша компания проводит ценную информацию для клиентов? Могут ли секреты пробились в вашу кодовую базу? Убедитесь, что вы Проверить безопасность Отказ Ваш код очень модульный, компоненты, используемые многими различными областями кода? Убедитесь, что все правильно отделено. Если ваша компания использует тестирование подразделения? Тогда вы должны убедиться, что объем автоматизированного тестирования является всеобъемлющим. Изменение кода в интенсивной области производительности программного обеспечения? Профилирование может быть ключевым элементом на вашем контрольном списке.
И так далее.
8. ИТЕРТ И УЛОЖИТЬ
Как и любой дизайн в программном обеспечении или иным образом, контрольный список должен улучшиться со временем Отказ Поместите себе контрольный список на повестку дня встречи. Получите обратную связь от всех, используя его, чтобы найти способы улучшить его. Не забудьте также получить вклад от кого-либо, которые не используют его. Это может помочь вам узнать, почему и как его можно сделать более доступными для них.
Иногда один размер подходит всем решением не будет работать . Может быть, другой отдел нуждается в другом контрольном списке, и, возможно, кто-то в вашей команде нужен другой подход, чтобы помочь им улучшить качество их кода. В любом случае, контрольные списки обычно не пишутся в камне и, как таковые, растут и развиваются с вашей кодовой базой.
Создание правильного контрольного списка кода CheckList Вам необходимо выполнить исследования о том, какие контрольные списки доступны, и отделите их друг от друга. Найдите предметы на них, которые говорят с дизайном вашей компании и интегрируют их.
Но самое главное, Продолжайте улучшить ваш контрольный список обзоров кода Отказ Скорее всего, вы получаете идеальный контрольный список в первый раз, когда вы построите один тонкий. Узнайте, какие Ошибки проскользнули через процесс обзора и добавьте необходимые элементы контрольного списка, чтобы они предотвратили их. И вырезать предметы, которые не дают никаких изменений. Подумайте об этом как о свободных неиспользованных объектах в памяти вашего рецензента.
Оригинал: «https://dev.to/eyalk100/8-tips-to-an-effective-code-review-checklist-3mlh»