Robienie dobrych code review to umiejętność, którą warto opanować. W artykule omówimy, jakie są zalety i wady tego procesu i w jakich projektach warto go stosować. Zastanowimy się, jakie podejście warto przyjąć, robiąc review kodu, w jaki sposób najlepiej to robić, na jakich aspektach kodu możemy się skupić i wreszcie – w jakiej formie pisać komentarze z naszymi uwagami do kodu, aby służyły one dla dobra projektu, a cały ten proces był okazją do owocnej komunikacji między członkami zespołu a nie źródłem konfliktów.
Dostałeś/aś do zrobienia swój pierwszy code review i nie wiesz, jak się za to zabrać? Na co zwracać uwagę, przeglądając czyjś kod? W jakiej formie pisać komentarze? A może kod, który ty piszesz, będzie podlegał review innych osób i nie wiesz, czego się spodziewać ani jak zareagować? o ile tak, to ten artykuł jest dla ciebie! choćby jednak o ile jesteś już doświadczonym programistą, znajdziesz tu zestaw porad, z którymi być może się zgodzisz, a być może nie, ale z pewnością dadzą one do myślenia...
Zagadnienia poruszane w tym artykule:
- Kiedy i po co robić code review?
- Czy warto robić code review w danym projekcie?
- Jak podchodzić do sprawy?
- Jak wykonywać code review?
- Na co zwracać uwagę?
- Przykłady kiepskich komentarzy i poprawionych wersji;
- W jaki sposób pisać komentarze?
Artykuł pochodzi z magazynu Programista nr 112 (2/2024). Szczegółowy spis treści wydania nr 112: https://programistamag.pl/programista-2-2024-112/
Autorem artykułu jest Adam Sawicki. Programista zainteresowany głównie tematem grafiki i gier. Aktualnie pracuje jako Principal Developer Technology Engineer w AMD, wcześniej m.in. w firmie Intel, Microsoft, w branży gier, w telewizji. Ma szerokie doświadczenie – od niskopoziomowego programowania sterowników graficznych i silników gier po fotografię, montaż wideo i VJ-ing na imprezach. Mgr inż. informatyk – absolwent Politechniki Częstochowskiej. Autor wielu artykułów i prelekcji. Od ponad 20 lat prowadzi bloga asawicki.info.