Jak wykonywać przeglądy kodu

Przeglądy kodu są jednym z elementów wymaganych do zaliczenia implementacji przypadku użycia. Należy wykonywać je przy pomocy narzędzia CodeRemarks www.coderemarks.com. Odnośnik do przeprowadzonego przeglądu kodu należy umieścić w postaci komentarza w zagadnieniu reprezentującym dany przypadek użycia w systemie JIRA. Przeglądowi powinien zostać poddany kod dodany lub zmodyfikowany w ramach implementacji danego przypadku użycia.

Celem przegląd kodu jest wykrycie w kodzie konstrukcji, które prowadzą do obniżenia jakości projektu i późniejszych problemów oraz niepotrzebnych kosztów związanych z utrzymaniem. Dobrą podstawą do podejmowania decyzji o poprawności poszczególnych konstrukcji programistycznych jest książka "Czysty kod" autorstwa Roberta C. Martina. Zaleca się wszystkim osobom zaangażowanym zarówno w pisanie jak i w przeglądanie kodu zapoznanie się z tą pozycją. Duża część informacji zawartych we wspomnianej książce została również opracowana i udostępniona w postaci listy kontrolnej (Lista kontrolna przeglądu kodu). Listą tą można się posługiwać podczas wykonywania przeglądów. W trakcie wykonywania przeglądu warto również pomagać sobie narzędziem do statycznej analizy kodu źródłowego, jakim jest uruchomiony na infrastrukturze projektowej system Sonar.

Przegląd kodu nie powinien być wykonywany przez autora. Wszystkie nieprawidłowości zgłoszone w trakcie przeglądu powinny zostać poprawione przed zajęciami, na których będzie rozliczany przypadek użycia, którego przegląd dotyczył. Dopuszcza się możliwość zachowania bez zmiany kody wskazanego przez przeglądającego wtedy, gdy autor będzie miał na tyle silne argumenty przemawiające za oryginalnym rozwiązaniem, że uda mu się przekonać przeglądającego.

Może się zdarzyć, że w przeglądanym kodzie osoba przeglądająca nie znajdzie żadnych problemów wymagających poprawy. W takiej sytuacji trzeba się jednak liczyć z tym, że zablokuje to zaliczenie implementacji Przypadku Użycia. Sytuacja taka może mieć miejsce, gdy prowadzący w trakcie sprawdzania implementacji wskaże stosowanie złych praktyk w kodzie, co będzie w opozycji do tezy przeglądającego kod sugerującej brak problemów.