Przerwa kawowa #38. Co to jest przegląd kodu i dlaczego jest potrzebny? Syndrom oszusta jest najlepszym przyjacielem programisty

Co to jest przegląd kodu i dlaczego jest potrzebny?

Źródło: DZone Rozpoczęcie startupu jest trudne, ale pisanie dla niego oprogramowania nie jest łatwiejsze. Aby oprogramowanie działało dobrze, potrzebny jest dobry kod. Ale skąd możesz mieć pewność, że Twój kod jest naprawdę dobry? Pracując z kodem klienta, odkryliśmy, że wielu niezależnych programistów, a nawet firm IT ignoruje recenzje kodu. Cóż, ponieważ nasz zespół uważa przegląd kodu za standardowy etap pracy, postanowiliśmy wyjaśnić nasz punkt widzenia. Zacznijmy więc od podstawowej terminologii.

Co to jest recenzja kodu?

Jest to systematyczne badanie kodu źródłowego oprogramowania w celu znalezienia błędów i oceny jakości. Przegląd kodu składa się z następujących kroków:

• Określenie najskuteczniejszych sposobów wykonania zadania;
• Szukaj błędów logicznych;
• Wyszukaj najczęstsze luki;
• Wykrywanie złośliwego oprogramowania to specjalny rodzaj kontroli kodu mający na celu poszukiwanie podejrzanych fragmentów kodu lub wyszukiwanie złośliwego oprogramowania zintegrowanego z oprogramowaniem.

Dlaczego potrzebujesz przeglądu kodu?

Istnieje kilka powodów, dla których przegląd kodu jest uważany za niezbędną część programowania. Pierwszym powodem jest redukcja ryzyka. Załóżmy, że masz oprogramowanie napisane przez freelancera lub agencję, ale nie jesteś pewien jakości pracy, bo nawet dobrzy programiści mogą coś przeoczyć. Dlatego zawsze warto sprawdzić ponownie. Co więcej, pracując razem nad nauką kodu, każdy członek zespołu może wymyślić mądrzejsze rozwiązania, które poprawią ogólną wydajność projektu. Najważniejszą rzeczą do zapamiętania w przypadku przeglądów kodu jest to, że należy je wykonać ZANIM nowy zespół programistów zajmie się bazą kodu lub projektem. Przegląd kodu przed uruchomieniem projektu daje Twojemu zespołowi możliwość przejrzenia go i określenia jakości kodu oraz tego, czy potrzebne są ulepszenia.

Przewodnik po przeglądzie kodu

Bazując na naszym doświadczeniu postanowiliśmy przygotować krótki przewodnik dla programistów, którzy zamierzają sprawdzić kod źródłowy swoich projektów.

Podziel recenzje kodu na przedziały czasowe

Nie próbuj analizować całego projektu na raz. Eksperci radzą, aby nie przeglądać więcej niż 400 linii kodu na raz. Co więcej, jednorazowa kontrola nie powinna zająć więcej niż godzinę. Człowiek nie jest w stanie efektywnie przetworzyć takiej ilości informacji, zwłaszcza przez długi czas. Po przekroczeniu tego poziomu zdolność wykrywania błędów wyraźnie spada, przez co możesz przeoczyć niektóre ważne błędy.

Poproś o pomoc swoich kolegów z drużyny

Jedna głowa jest dobra, ale dwie lepiej. Możesz być zaskoczony, jak bardzo poprawi się jakość Twojej recenzji, jeśli udostępnisz ten proces komuś innemu. Jesteśmy przyzwyczajeni do wspólnych recenzji kodu przy użyciu Atlassian's Crucible . Narzędzie to pozwala przypisać dodatkowych recenzentów, omówić wybrane linie kodu źródłowego, pliki lub cały zestaw zmian. Wspólny przegląd kodu nie tylko ulepsza oprogramowanie, ale także podnosi kompetencje zespołu, dzieląc się wiedzą w drodze dyskusji.

Wskaźniki nagrywania

Przed rozpoczęciem przeglądu zespół powinien wyznaczyć precyzyjne cele, takie jak „zmniejszenie wskaźnika defektów o połowę”. Cel „znalezienia większej liczby błędów” jest zbyt abstrakcyjny i dlatego niemożliwy do osiągnięcia. Podczas przeglądu zapisz wskaźniki, takie jak szybkość sprawdzania, liczba błędów wykrytych na godzinę i średnia liczba błędów na linię kodu. Stałe monitorowanie wyników przeglądu pokaże Ci prawdziwy obraz procesów wewnętrznych.

Zachowaj pozytywne nastawienie

Recenzje kodu mogą czasami pogorszyć relacje w zespole. Nikt nie lubi być krytykowany, dlatego bardzo ważne jest utrzymywanie przyjaznej atmosfery, chyba że chcesz, aby Twoi współpracownicy stracili motywację. Zamiast negatywnie patrzeć na każdy błąd, potraktuj go jako nową okazję do ogólnej poprawy jakości swojego kodu.

Skonfiguruj proces korekcji błędów

Twój zespół zakończył przegląd kodu, ale co z naprawieniem znalezionych błędów? Zaskoczeniem była dla nas informacja, że ​​nie wszystkie zespoły programistów mają ustaloną metodę poprawiania wykrytych błędów. Na szczęście wspólnie pracujemy nie tylko nad znalezieniem błędów, ale także ich naprawieniem. Wszystkie błędy są omawiane z twórcą (z wyjątkiem sytuacji, gdy przeglądamy kod innego zespołu), a wszystkie zmiany są zawsze zatwierdzane przed przesłaniem do źródła.

Zreasumowanie

Przegląd kodu powinien być ważnym procesem w każdej firmie programistycznej, ponieważ pomaga utrzymać wysokie standardy kodowania. Wspólna praca nad przeglądami kodu jednoczy zespół i daje możliwość dzielenia się wiedzą i doświadczeniem w firmie. Niezależnie od tego, czy prowadzisz startup, czy przekazujesz projekt innemu zespołowi, zawsze rób przegląd kodu, aby mieć pewność, że Twoje oprogramowanie jest najwyższej jakości.

Syndrom oszusta jest najlepszym przyjacielem programisty

Źródło: Catalins.tech Po przeczytaniu tytułu możesz pomyśleć, że coś jest ze mną nie tak. Ale powtórzę to jeszcze raz: syndrom oszusta jest najlepszym przyjacielem programisty, jeśli zostanie skierowany we właściwym kierunku. Wierzę również, że syndrom oszusta jest tak powszechny w tworzeniu oprogramowania ze względu na ogrom wiedzy, którą trzeba posiadać oraz ciągłe zmiany narzędzi i języków programowania. Język programowania i narzędzia, których używasz dzisiaj, mogą za rok stać się nieaktualne. Oznacza to, że ponownie w pewnym stopniu będziesz musiał „zaczynać od zera”. Tworzenie oprogramowania to bardzo dynamiczne środowisko, w którym trzeba się ciągle uczyć. Ale pomimo trudności można się do nich przyzwyczaić. Dlatego prawie niemożliwe jest pozbycie się syndromu oszusta. Dlaczego więc nie nauczyć się z tym żyć?

Większość z nas to ma

Pozwól, że powiem ci coś innego. Prawie każdy z nas cierpi na syndrom oszusta. Zawsze jest ktoś lepszy od nas. Zawsze jest coś, czego nie wiemy. Zawsze jest coś do nauczenia się. Każdego dnia pojawia się nowe narzędzie. Co jakiś czas pojawia się nowa technologia lub język programowania. Nigdy nie będziesz w stanie nauczyć się wszystkiego. Próba dotrzymania kroku jest również bardzo trudna. I tak objawia się ten syndrom. Zaczynasz zadawać sobie pytania: „Czy kiedykolwiek będę w stanie to zrobić?”, „Czy kiedykolwiek będę w stanie zrobić x, y, z?”, „Czy rozpoznam technologie x, y, z? „, „A co, jeśli jestem oszustem?”, a lista jest długa. Odpowiedź brzmi: tak, tak i tak. Nawiasem mówiąc, syndrom oszusta jest gorszy dla tych początkujących, którzy czują, że nigdy nie odniosą sukcesu w tej dziedzinie. Ja też przez to przeszedłem. Syndrom można pokonać ciężką pracą.

Wyobrażać sobie

Nie jesteś jedyną osobą, która zadaje sobie te pytania. Twój kolega z pracy ma te same problemy. Deweloper, którego obserwujesz na Twitterze, również ma podobne pytania. I bloger wideo z 50 000 subskrybentów. I te pytania też się przede mną pojawiają, choć mam pracę i wszystko jest w porządku. Pytania nie tylko Cię nurtują. Syndrom oszusta jest częścią naszego zawodu. Oczywiście niektórzy radzą sobie z tym lepiej, więc nie jest takie oczywiste, że oni też mają problemy. Ale uwierz mi: prawie każdy z nas je ma.

Co robić?

Przede wszystkim musisz zrozumieć, że syndrom oszusta może stać się Twoim najlepszym przyjacielem. W końcu popycha cię do stawania się lepszym. Poczucie, że nie nadajesz się do tej branży lub że nie wiesz zbyt wiele, może być zachętą do zdobywania wiedzy. Dzięki temu z każdym dniem stajesz się lepszy. Używam syndromu oszusta jako paliwa, motywacji do stania się lepszym programistą i działa to bardzo dobrze. Ale bądź ostrożny – może to szybko popchnąć Cię w stronę wypalenia zawodowego. Uwierz mi, nie potrzebujesz tego. Ilekroć w Twojej głowie pojawią się pytania i irracjonalne myśli, PAMIĘTAJ, że wszyscy programiści cierpią na ten sam syndrom. PAMIĘTAJ, że zawsze znajdzie się lepszy programista od Ciebie. Ale PAMIĘTAJ też, że zawsze znajdzie się programista gorszy od Ciebie. PAMIĘTAJ, że nigdy nie możesz wiedzieć wszystkiego i to jest w porządku. Wystarczy znać kilka narzędzi, które są istotne dla Twojej pracy. Dzięki wytrwałości możesz zostać dobrym programistą. Czy myślisz, że zostaniesz najlepszym programistą? Najprawdopodobniej nie. Czy będziesz pracować dla Amazon/Facebook/Google/Apple? Prawdopodobnie też nie. Czy zarobisz miliony? Ledwie. Ale wiesz co? Jest okej. Nie musisz robić żadnej z tych rzeczy, aby zostać dobrym programistą. Ponieważ w rzeczywistości większość z nas nigdy nie osiąga wszystkich tych celów.

Pamiętać

1. Prawie każdy z nas cierpi na syndrom oszusta.
2. Dzięki wytrwałości możesz osiągnąć sukces w tej branży.
3. Nigdy nie dowiesz się wszystkiego i to jest w porządku.
4. Zawsze są lepsi programiści od Ciebie, ale są też gorsi programiści od Ciebie.
5. Nie musisz być programistą supergwiazdą. Wystarczy być dobrym w swojej pracy.