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

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

1. Прочтите спецификации

Это первое, что вам всегда нужно делать. Никаких исключений из этого. Хотя проверка кода сосредоточена на написанном коде, для начала вам нужно знать, «почему» мы написали этот код.

Чтение спецификаций также дает вам возможность придумать сценарии ошибок, которые, как вы ожидаете, код должен уметь обрабатывать.

2. Запустите эти автоматические тесты.

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

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

3. Посмотрите результат сами.

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

4. Ищите распространенные ошибки.

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

  1. Несоблюдение стандартов кода (например, именование переменных, интервал табуляции, комментарии фиксации, комментарии к коду и т. Д.)
  2. Обработка пустых и пустых строк. Для вещей, которые могут быть нулевыми или пустыми, проверьте, правильно ли обрабатывает остальной код.
  3. Повторный код и другие возможности рефакторинга.
  4. Отсутствие обработки ошибок и ведения журнала. В зависимости от стандартов вашего проекта это может быть, а может и не иметь большого значения. Лично мне нравится иметь возможность перехватывать исключения, регистрировать их и показывать пользователю дружеское сообщение.
  5. Освобождение ресурсов. Проверьте такие вещи, как подключения к базе данных или потоки памяти. Следите за тем, чтобы от них избавились должным образом.

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