Какова цель проверки кода

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

Итак, какова цель проверки кода?

Есть несколько причин, по которым вы хотели бы провести проверку кода:

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

Существует несколько бизнес-кейсов для проведения обзоров:

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

Если вы ищете всестороннее обсуждение преимуществ и стратегий реализации для экспертных обзоров, я бы порекомендовал проверить экспертные обзоры в Software: A Practical Guide от Karl Wiegers .

Обзоры кода являются инструментом для передачи знаний .

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

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

  Тщательный анализ кода потребует частых проверок различной документации. Это отличный способ выучить язык или API.

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

Обзоры кода не о:

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

• … Придирчивость к стилевым проблемам - остановитесь на одном стиле и используйте его для автоматизации. Но есть много вещей, которые автоматизированный инструмент не может проверить. Обзоры кода - это хорошее место, чтобы убедиться, что код достаточно документирован или самодокументирован.

Самая ценная вещь, которую я лично получаю из обзора кода, - это уверенность, что код понятен другому человеку. Переменные четко названы? Является ли цель каждого куска кода достаточно очевидной? Что-то двусмысленное уточняется с комментарием? Описаны ли крайние случаи и допустимые значения параметров в комментариях и проверены ли они в коде?

Я хотел бы добавить две области, не охваченные другими хорошими ответами:

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

Еще одна веская причина - это более безопасные методы разработки. Достаточно взглянуть на ошибку Apple goto (случайное дублирование строки кода) или ошибку Heartbleed (базовый сбой при проверке входных данных), чтобы понять важность правильных проверок кода в безопасном жизненном цикле разработки.