5 Советов По Проведению Хорошего Обзора Кода

Проверка кода — одна из наиболее ценных инженерных практик.

1. Обзоры кода улучшают качество кода: один обзор — хорошо, а два — лучше.

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

3. Обзоры кода помогут вам изучить лучшие практики других разработчиков.

4. Обзоры кода можно использовать для проверки понятности и простоты всего приложения.

Как вы, возможно, заметили, я не упомянул в этом списке, что проведение проверок кода помогает находить ошибки и поддерживать стандарты кодирования, и вот почему: 1. Обзоры кода НЕ ДОЛЖНЫ проводиться с целью поиска ошибок.

2. Обзоры кода НЕ ДОЛЖНЫ проводиться с целью проверки соблюдения стандартов кодирования.

10 лет назад эти два пункта имели бы смысл при проверке кода.

Однако теперь вам следует использовать инструменты автоматического тестирования и инструменты, отслеживающие формат вашего кода.

Это не означает, что вы не должны замечать ошибки в кодировании и проектировании во время проверки кода; это означает, что их поиск не является целью проверки кода.

С этой точки зрения позвольте мне дать вам 5 советов по проведению хорошего обзора кода.



1. Часто проводите проверки кода.

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

Я работал в компании, где последним этапом разработки был большой код-ревью всего приложения.

Это было абсолютно бесполезно, поскольку поздние проверки кода имеют следующие недостатки.

  • Чем больше кода необходимо просмотреть, тем больше вероятность того, что разработчик не согласится на последующий рефакторинг.

  • Чем больше времени разработчик тратит на работу над фрагментом кода, тем больше вероятность того, что этот фрагмент кода станет «личным».

    Хочу напомнить, что одна из главных проблем разработчиков — это их эго.

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

  • Чем ближе дата релиза, тем менее приоритетной становится работа по улучшению кода.

Лично я провожу проверку кода каждый раз, когда заканчиваю писать что-то нетривиальное — обычно несколько раз в день.



2. Делайте обзоры быстрыми и неформальными.

Забудьте о списках, просто обернитесь и попросите одного из коллег уделить вам 5 минут. Если у вас есть список, то одно из этого обязательно произойдет: 1. При проверке будет проверено только то, что указано в вашем объявлении.

2. Проверка кода станет формальностью.

Люди будут тратить как можно меньше времени на просмотр кода и делать вид, что он им действительно нужен.

Короткие и неформальные обзоры — это, по сути, диалоги, в которых человек не чувствует, что его рассматривают, а просто дают советы.



3. Проводите ревью кода с разными людьми.

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

1. Полезно услышать разные точки зрения.

2. В будущем вашим кодом смогут поделиться больше людей.

3. Повышается командное взаимодействие.



4. Будьте позитивны.

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

И помните: вы — не ваш код!

5. Научитесь получать удовольствие от проведения обзоров.

Это самый важный совет. Если вы работаете в команде, где людям нравится проверять код, то каждый будет участвовать в написании кода, который понравится не только автору, но и всей команде.

__________

В комментариях вы можете поделиться, проводите ли вы code review, как вы это делаете, есть ли у вас интересный опыт и т.д.
Теги: #проверка кода #проверка кода #проверка кода #дизайн и рефакторинг
Вместе с данным постом часто просматривают:

Автор Статьи


Зарегистрирован: 2019-12-10 15:07:06
Баллов опыта: 0
Всего постов на сайте: 0
Всего комментарий на сайте: 0
Dima Manisha

Dima Manisha

Эксперт Wmlog. Профессиональный веб-мастер, SEO-специалист, дизайнер, маркетолог и интернет-предприниматель.