Полезное код ревью

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

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

  • там скорее всего не будет замечаний типа: "тут надо добавить пустую строку", "а давай переименуем эту переменную", "а здесь - опечатка", "а почему тут используется конкретная коллекция, а не ее интерфейс?"

  • вы не встретите просто вопросы без конкретных предложений и фактов

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

  • комментарии короткие и емкие, без излишних рассуждений

  • в спорных моментах опытный и адекватный разработчик укажет ссылку на общепринятые стандарты или документацию

  • не станет упорно доказывать свою правоту в переписке под ревью - просто укажет на факты и как неисправленный код может "выстрелить" в будущем

Идея заключается в том, что чаще всего всякие очевидные вещи:

  • правила именования в коде,
  • различные косметические вещи проверяются автоматическими инструментами и анализаторами.

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

И, конечно, всегда выигрывает симбиоз опыта и здравого смысла!