Z tego wpisu dowiesz się:

• jak przeprowadzać code review?
• o czym pamiętać, aby inspekcja kodu była efektywna?
• jakich błędów unikać?

O tym, jak ważną praktyką w każdej firmie programistycznej jest code review, nie trzeba nikogo przekonywać. Doskonalenie umiejętności developerów, wymiana wiedzy w zespole, lepsza jakość produktu, utrzymanie wysokich standardów panujących w organizacji to tylko niektóre korzyści wynikające z przeglądu kodu. Odpowiednio przeprowadzony praktycznie nie ma wad. O czym zatem pamiętać, aby code review spełnił swoją rolę?

Krytyka kodu, nie autora

Zgłaszanie uwag, które nieodłącznie związane jest przeglądem kodu, nierzadko jest powodem konfliktów interpersonalnych w zespole. Za każdym fragmentem kodu stoi bowiem żywy człowiek a nie jest tajemnicą, że programiści bywają bardzo przywiązani do swojego dzieła. Nieumiejętnie przekazana, zbyt krytyczna ocena, zamiast przyczynić się do rozwoju programistycznych umiejętności, może popsuć relacje między członkami teamu. Dlatego konieczne jest oderwanie kodu od nastawienia do jego autorów. Zadaniem recenzenta jest tylko i wyłącznie danie konstruktywnego feedbacku kodu, który dostał do oceny.

Krok po kroku

Bardzo ważne jest, aby poddawany code review kod dzielić na małe fragmenty. Z jednej strony daje to większą kontrolę nad postępami prac, z drugiej sprawia, że cały proces jest szybszy i łatwiejszy dla obu stron. Choć im mniejsze porcje dostaje do oceny recenzent, tym lepiej, zawsze konieczny jest ogląd całości kodu, jego kontekstu, a nie tylko jego wycinka. W przypadku dużych projektów niezbędne jest z kolei dokonywanie cyklicznych „cząstkowych” przeglądów a na koniec review odbiorcze.

Czas i spokój

Code review jest czynnością wymagającą ogromnego skupienia uwagi i niezwykle absorbującą. Odkładanie go na ostatni dzwonek, tuż przed prezentacją lub deadline’m, nie zapewni kodu dobrej jakości. Na porządną recenzję potrzeba czasu i spokoju. Dlatego dobrym zwyczajem jest wykonanie jej odpowiednio wcześnie tak, aby był czas na wprowadzenie ewentualnych poprawek. Warto również zadbać o to, aby maksymalny czas jednej sesji, jaką przeznaczamy na przegląd kodu nie przekraczał dwóch godzin. Spędzenie całego dnia na przeglądaniu kodu może okazać się zbyt męczące i nie zapewni odpowiednich efektów.

Inaczej nie znaczy gorzej

Recenzowaniu kodu niejednokrotnie towarzyszy myśl: „Nie zrobiłbym tego w ten sposób”. Sposoby podejścia do rozwiązaniu danego problemu mogą się jednak różnić w zależności od programisty. Szczegółowe komentarze, jasne zdefiniowanie problemu i zaproponowanie alternatywnych rozwiązań mogą stanowić punkt wyjścia do skonfrontowania różnych pomysłów na kod. Dzięki temu programiści mogą uczyć się od siebie. A to bardzo cenne.

Code review to niezwykle użyteczne narzędzie, które, odpowiednio przeprowadzone, może przynieść wiele korzyści każdej ze stron: programiście, firmie i klientowi. Warto zatem dołożyć starań, aby był on jak najbardziej wydajny.