Как сделать код-ревью, если вы разработчик-одиночка
2 апреля 2023 г.Проверка кода — это хорошо. Это помогает улучшить качество кода, налаживает совместную работу в команде и побуждает разработчиков знакомиться с самыми удаленными уголками исходного кода, которые они не посетили бы без проверки кода. Из всего, что обычно делают программисты, именно проверка кода лучше всего отражает истину пословицы «Две головы лучше, чем одна».
Но как насчет тех программистов, которые работают в одиночку? Как они могли иметь независимый код-ревью имея только одну голову - если они не мутанты. Именно этой головой они пишут код, который потом приходится проверять. Как автор может посмотреть на свой код глазами другого человека? Это кажется невыполнимой задачей, неразрешимой проблемой, тупиком!
Но есть решение! Из биологии мы знаем, что человеческий мозг имеет две достаточно самостоятельные части - полушария мозга, каждое из которых видит мир через свой глаз, соединенный крест-накрест: левое полушарие через правый глаз, а правое полушарие соответственно через левый.
Именно это делает возможным независимый обзор кода для одного разработчика! Потому что при написании программы мы используем наш мозг в целом, оба его полушария работают вместе и в принципе представляют собой принципиально иную систему, чем каждая часть мозга в отдельности. Таким образом, если бы вы могли видеть свой код с точки зрения одного полушария, это было бы грубым аналогом независимого анализа кода. Чтобы посмотреть на код только одним полушарием, вы можете использовать простую медицинскую повязку или покрытие, закрывающее один глаз, в то время как другой глаз и прикрепленное к нему полушарие мозга просматривают код.
При таком подходе вы можете использовать еще больше функций! Биологи считают, что полушария мозга имеют специализации: левое отвечает за логику, а правое - за творчество, интуицию и эстетическое восприятие. Таким образом, проверка кода правым глазом задействует левую часть мозга, которая, по идее, должна лучше находить проблемы с логикой кода. А проверка кода левым глазом теоретически могла бы лучше обнаруживать эстетические недостатки кода, такие как согласованность стиля и элегантность архитектурных решений.
Конечно, ревью собственного кода не стоит делать сразу после его написания! Немного отдохните, это поможет вам абстрагироваться от кода, передумать, войти в другое настроение. Еще эффективнее переключиться на другую деятельность, например, на физические упражнения, просмотр фильма, чтение книги или даже употребление небольшого количества алкоголя — это поможет вам полностью изменить свое настроение и посмотреть на свой код глазами другой личности. Имейте в виду, что количество алкоголя не должно быть слишком большим, иначе ваша измененная личность станет совершенно нелогичной. Есть также много других подходов, меняющих сознание, но мы бы предпочли не вдаваться в подробности и остановиться на этом.
После перерыва и изменения состояния сознания вы готовы просмотреть код. Лучше делать это по раундам: сначала сделайте код-ревью одним глазом, затем повторите со вторым. Как и в случае обычного обзора, обнаруженные проблемы должны быть немедленно описаны в . комментарии к обзору кода.
После завершения обзора необходимо снова отдохнуть. После чего можно приступать к исправлению найденных недостатков кода, на этот раз — обоими глазами. Если есть спорные и дискуссионные замечания по код-ревью — обсуждайте их в комментариях. На следующем раунде обзора кода полушарие мозга, написавшее их, рассмотрит ваши ответы и, возможно, продолжит обсуждение. После нескольких раундов код-ревью обычно не остается вопросов по коду, и код-ревью можно считать завершенным.
Конечно, вы должны делать свои комментарии максимально корректными, не оскорбительными и вежливыми, потому что вы не хотите скандалить с самим собой! И помните, что нужно быть осторожным с тем, что меняет мышление и расщепляет личность, иначе вы дадите неврологам и психиатрам еще один повод рассказывать забавные истории о причудливых айтишниках.
н
Оригинал