Яка мета огляду коду

Я зараз намагаюся продати свою організацію за значенням оглядів коду. Я працював у кількох місцях, де вони працювали. Я бачив, як вони використовувались для вибору стилів і функціональних рішень, і я бачив, що вони використовуються лише як перевірка кишок, щоб переконатися, що нічого небезпечного не реалізується. Моє відчуття кишки полягає в тому, що найефективніша мета - десь між двома варіантами.

Отже, яка мета огляду коду?

Є кілька причин, чому ви хочете провести перевірку коду:

• Освіта інших розробників. Переконайтесь, що всі бачать модифікацію, пов’язану з виправленням дефекту чи вдосконаленням, щоб вони могли зрозуміти решту програмного забезпечення. Це особливо корисно, коли люди працюють над компонентами, які потрібно інтегрувати, або над складними системами, де одна людина може тривалий час відвідувати, не дивлячись на певні модулі.
• Пошук дефектів чи можливостей для вдосконалення. Як код, що доставляється, так і код тесту та дані можуть бути вивчені, щоб знайти слабкі місця. Це гарантує, що тестовий код є надійним та дійсним, а також, що дизайн та реалізація є узгодженими у всій програмі. Якщо необхідно внести додаткові зміни, це сприймає можливість ближче до точки входу.

Існує кілька ділових справ для проведення оглядів:

• Виявлення дефектів чи проблем, які потрібно було б переробити ближче до їх введення. Це дешевше.
• Спільне розуміння системи та крос-тренінг. Менше часу для розробника, щоб прискорити внесення змін.
• Визначення можливих удосконалень системи.
• Відкриття впровадження для того, щоб тестери забезпечили належне покриття. Перетворення чорної скриньки в сіру або білу рамку з точки зору тестування.

Якщо ви шукаєте всебічну дискусію щодо переваг та стратегій впровадження експертних оцінок, рекомендую ознайомитись з експертними оцінками у програмі: Практичний посібник Карла Вігерса .

Огляди коду - це інструмент для передачі знань .

• Коли розробники переглядають код один одного, вони отримують знайомство з усіма областями системи. Це зменшує коефіцієнт шини проекту та робить розробників ефективнішими, коли потрібно проводити технічне обслуговування для частини системи, про яку вони не писали.

• Коли молодший програміст переглядає код старшого, молодший програміст може підібрати трюки, інакше засвоєні лише досвід. Це також може коригувати надмірно складний код.

  Ретельний перегляд коду вимагатиме частих перевірок різної документації. Це прекрасний спосіб вивчити мову чи API.

• Коли старший програміст переглядає код молодшого, це можливість випрасувати проблеми, перш ніж вони перетворюються на технічну заборгованість. Огляд коду може стати хорошою умовою для наставництва молодших програмістів.

Огляди коду не про:

• … Виявлення помилок. Ось для чого тести. Все ще часто трапляється, що перегляд коду знайде певну проблему.

• … Нитчіпкінг щодо стильових питань - влаштуйтеся на один стиль та використовуйте автоматизовані форматори для його виконання. Але є багато речей, які автоматичний інструмент не може перевірити. Огляди коду є хорошим місцем, щоб переконатися, що код є достатньо задокументованим або самодокументованим.

Найцінніше, що я особисто отримую від огляду коду, - це впевненість, що код зрозумілий іншій людині. Чітко названі змінні? Чи є ціль кожного куска коду досить очевидною? Чи є щось неоднозначне уточнення з коментарем? Чи викладені кращі регістри та дійсні значення параметрів у коментарях та зареєстровані в коді?

Я хотів би додати дві області, не охоплені іншими чудовими відповідями:

Однією з відмінних причин для перегляду коду є ефект Хоторна, який у нашому випадку означає: Якщо ви знаєте, що хтось згодом подивиться на ваш код, тоді ви, швидше за все, напишіть його краще.

Ще одна важлива причина - кращі безпечні практики розвитку. Потрібно лише подивитися на помилку goto Apple (випадковий дубльований рядок коду) або помилку Heartbleed (основна помилка перевірки введення), щоб зрозуміти важливість правильних оглядів коду для безпечного життєвого циклу розробки.