Оригинальный автор: Софи Альперт
Переводчик: Джоти, UC International R&D
Спереди написано: Добро пожаловать в официальный аккаунт «UC International Technology», мы предоставим вам качественные технические статьи, связанные с клиентом, сервером, алгоритмом, тестированием, данными, интерфейсом и т. д., не ограничиваясь оригинальностью и перевод.
Недавно друг спросил меня, почему код-ревью важен. По крайней мере, большинство технологических компаний Силиконовой долины проверяют код каждого изменения, чтобы убедиться, что это изменение увидели как минимум два человека. На моей предыдущей работе мы делали обзоры кода выборочно (редко), а потом в команду пришел новый сотрудник Google и предложил нам проверить весь код — и мы это сделали. Это оказалось удивительным решением.
Если вы правильно просматриваете код, это вас не побеспокоит. Вы и ваш рецензент не противники, вы работаете вместе над созданием наилучшего программного обеспечения. (Суть в том, что не слишком возражайте против обратной связи — даже если вам нужно изменить код, это не означает, что у вас есть проблема. Получить обратную связь — это нормально, потому что это помогает вам расти!)
В некоторых компаниях строго оговаривается, сколько человек должно проверять каждый фрагмент кода, и они должны определить строгого владельца для каждого фрагмента кода. Я не думаю, что это вообще необходимо, я предпочитаю более простую систему, где единственным правилом является проверка каждого фрагмента кода. На практике вам все равно придется отправлять комментарии людям, которые поддерживают измененный вами код, но лучше не предъявлять жестких требований.
Вот основные причины, которые приходят мне на ум, почему отзывы важны. Достаточно много!
-
сам код.Самая очевидная ценность проверки кода — «поиск ошибок». Или, если вы копнете немного глубже и обнаружите некоторые примеры передового опыта или потенциальных правил, о которых автор не знает, вы можете сообщить ему об улучшении конкретного кода.
-
Обмен знаниями на макроуровне.При просмотре чужого кода вы на самом деле изучаете новую полезную технику — и наоборот, возможно, кто-то другой дал вам лучший совет при просмотре вашего кода. Если вы сможете применить то, чему научились, вы станете великим инженером.
-
Обмен знаниями на микроуровне.Смягчите «автобусный фактор», увеличив количество людей, знакомых со всеми кодами. (Примечание переводчика: чем больше коэффициент автобуса, тем меньше вероятность того, что на проект повлияет потеря ключевого персонала)
-
Обмен тенденциями.Соответственно, проверка кода заставляет вас сообщать своим товарищам по команде, что вы делаете, и у вас есть возможность откатиться назад, что также гарантирует, что вы на правильном пути.
-
Коммуникативная практика.Будь то внутри вашей команды или за ее пределами, четкая коммуникация — самый важный навык для успешной работы! Обзоры кода дают вам возможность попрактиковаться в четком написании, будь то описание цели изменения или отправка отзыва. И, если повезет, в следующий раз, когда вы соберетесь написать что-то «очень важное», вы будете готовы.
-
запись истории.По моему опыту, люди лучше пишут коммит-сообщения, если знают, что то, что они пишут, будет прочитано. Это очень полезно при просмотре старых изменений!
-
что-то обсудить.Иногда вы хотите согласиться на изменение, и вам может быть трудно устно описать и выразить согласие с конкретными деталями алгоритма. Общение через фрагмент кода является более точным, потому что код имеет тенденцию быть более явным.
-
Единство команды.Когда обзоры кода становятся регулярным мероприятием, вы можете больше почувствовать себя командой, работающей вместе, а не каждым «своим путем».
-
Практика чтения.Практика чтения чужого кода поможет вам сделать собственный код более читабельным (и, следовательно, удобным для сопровождения). Это позволит вам писать лучший код позже!
Если у вас нет выбора, то 2, 5, 6 могут быть самыми важными для меня.
Посмотреть оригинальный английский
Хорошая рекомендация статьи: Углубленный выпуск автора React о хуках, который стоит прочитать
«UC International Technology» стремится делиться с вами высококачественными техническими статьями.
Добро пожаловать, чтобы подписаться на наш официальный аккаунт и поделиться статьей с друзьями