Автор оригинала: Vlad Mihalcea.
Обзор кода-отличный программный инструмент, и вы обязательно должны использовать его для улучшения качества вашего кода. Но, как и любой другой инструмент, иногда им можно злоупотреблять. Вот почему я составил список лучших практик, которыми вы можете руководствоваться при просмотре кода ваших коллег.
- Проверка кода не является тестированием : Проверка кода-это бизнес от разработчика к разработчику, и она не предполагает никакого тестирования. Проверка кода должна проверить, выполняются ли требования задачи максимально чистым способом.
- Вы не указываете, что проверять код : Точно так же, как вы не указываете тестировщику, что тестировать, вы никогда не должны указывать своему коллеге, что проверять. Магия экспертной оценки исходит из вашей собственной точки зрения на текущую разработку и реализацию задач. Два ума всегда лучше, чем один.
- Вы всегда должны проверять все изменения : Ошибки могут быть скрыты где угодно, и вы должны тщательно их искать. Чтобы получить полную картину, вам нужно пройти через все изменения.
- Требования в первую очередь : Требования являются наиболее важной движущей силой. В конце концов, это то, за что платит клиент. Если текущие изменения неоптимальны, вам необходимо повторно открыть проблему. Если вам посчастливилось обнаружить другие разделы кода, которые необходимо переработать, вам следует создать новые проблемы вместо повторного открытия текущей. “Принцип единой ответственности” применим как к задачам, так и к кодированию.
- Действие “Один ко многим” : Если вы не можете быть уверены, что поняли намерение изменить код, безопаснее попросить кого-нибудь еще просмотреть его дальше.
- Способ обучения : Обзор кода-отличный метод обучения, особенно в крупных проектах. В идеале вы должны ознакомиться со всеми аспектами вашего проекта, но если проект слишком велик, вы можете, по крайней мере, специализироваться на нескольких модулях.
Счастливого просмотра кода!