Project

General

Profile

Обзор кода

Подключен модуль Обзор кода
Added by Vyacheslav Anzhiganov over 3 years ago

Подключен модуль Обзор кода.

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

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

Последовательность действий при рецензировании кода

  1. Оцените, имеют ли смысл предложенные изменения. Возможно, кодер пытается улучшить фичу, от которой ваш проект собирается избавиться. Направьте его усилия в нужное русло.
  2. Изучите главную часть рецензируемого кода. Если затрудняетесь выделить эту главную часть, спросите разработчика. Найдя какие-то недостатки, немедленно сообщите автору кода. Переходить к изучению деталей кода до исправления основных недочётов нет смысла, вполне вероятно, что впоследствии эти детали значительно изменятся.
  3. Изучите остальную часть кода. Ориентируйтесь на логическую последовательность действий и проверьте каждый файл, возможно, сначала имеет смысл разобрать модульные тесты, чтобы иметь представление о том, какие именно изменения планирует внести разработчик.

Как писать комментарии во время рецензирования

  • Будьте благожелательны. Вы с разработчиком на одной стороне баррикад. Рецензируйте код, а не кодера.
  • Не будьте императивны, поясняйте свои рекомендации и указания. Это поможет разработчику лучше понять и выполнить их.
  • Объясните, чего вы хотите, но не делайте работу за кодера. Как правило, он всё же может сделать её лучше. Помните, разработчику нужно дать возможность развиваться. Опять же, не в ущерб качеству. Ищите баланс.
  • Предложите разработчику попробовать упростить код, а если это невозможно — добавить подробные комментарии.

Акивация модуля Обзор кода

Перейдите в проект, далее в "Настройки" и выберите вкладку "Модули"

Активация модуля Обзор кода

После активации модуля появится вкладка "Обзор кода"




Screen Shot 2019-11-26 at 21.39.09.png View (49.7 KB) Vyacheslav Anzhiganov, 11/26/2019 06:43 PM

Screen Shot 2019-11-26 at 21.39.39.png View (158 KB) Vyacheslav Anzhiganov, 11/26/2019 06:43 PM

Screen Shot 2019-11-26 at 21.40.46.png View (26.9 KB) Vyacheslav Anzhiganov, 11/26/2019 06:43 PM

Screen Shot 2019-11-26 at 21.40.14.png View (57.7 KB) Vyacheslav Anzhiganov, 11/26/2019 06:43 PM

Screen Shot 2019-11-26 at 21.48.11.png View (39.2 KB) Vyacheslav Anzhiganov, 11/26/2019 06:49 PM


Comments