Zespół

Sztuczka ułatwiająca pracę w zespole

Kiedy pracuje się w zespole, ważne jest żeby ustalić reguły pisania kodu. W ten sposób łatwiej będzie odnaleźć się w kodzie kolegi. Można ustalić konwencje nazewnictwa, strukturę plików czy nazewnictwo gałęzi w systemie kontroli wersji. To nie wszystko bo istnieją techniki pisania kodu, które wspomagają pracę zespołową.

Spójrzmy na poniższy kod:

var array = [
   1,
   2,
   3,
   4,
   5
];

Widzimy tutaj deklarację tablicy w JavaScripcie. Właściwie nic szczególnego i w sumie wszystko zrozumiałe. Ja takie tablice zapisuję w taki sposób:

var array = [
   1,
   2,
   3,
   4,
   5,
];

Po co ten redundantny przecinek na końcu? Zużywam tylko więcej pamięci na przechowywanie niepotrzebnych znaków? Ten zabieg ma na celu polepszenie sprawdzania kodu przez współpracowników. Różnię można zobaczyć kiedy używamy narzędzia pull request na github.com albo bitbucket.org. Wyobraźmy sobie sytuację kiedy zostawimy w tablicy tylko trzeci element. Pull request w pierwszym przypadku wyglądał będzie tak:

Bez przecinka

Natomiast w drugim:

Z przecinkiem

Jak widać dodawanie przecinków w tablicach sprawia że podgląd zmian jest bardziej czytelny. Kiedy zmian będzie dużo to taki zabieg pozwala na dużo lepsze zrozumienie zmian przez współpracowników. Nie trzeba porównywać kodu usuniętego z dodanym żeby wyszukać co zostało zmienione a co nie. Widać jasno co tak na prawdę się zmieniło i nie trzeba długo się nad tym zastanawiać.

 

Obrazek z Freepik.

4 myśli na temat “Sztuczka ułatwiająca pracę w zespole

  1. Zgadzam się, ALE… jeśli używamy takiego kodu JavaScript „as is” możemy mieć spory problem z naszym ulubionym Internety Explorerem, zwłaszcza z wersjami sprzed IE9, który nie radzi sobie z dodatkowymi przecinkami. Warto spojrzeć na http://stackoverflow.com/questions/5139205/javascript-can-a-comma-occur-after-the-last-set-of-values-in-an-array i http://stackoverflow.com/questions/7246618/trailing-commas-in-javascript. Taki właśnie zapis jest jednak jak najbardziej zalecany przez Airbnb w najbardziej chyba znanym i upowszechnionym podręczniku stylu (tutaj: https://github.com/airbnb/javascript#commas–dangling). W takich przypadkach bardzo przydają się transpilery (kompilatory code-to-code) takie jak Babel, które eliminują potencjalne problemy z nadmiarowym przecinkiem.

    1. Dziękuję za słuszną uwagę. Jeśli chodzi o utrzymanie aplikacji, która ma pracować na IE10> to rzeczywiście trzeba się pilnować i używać takiej składni, jakiej wymagają starsze przeglądarki. Jednym ze sposobów jest używanie transpoilerów a innym używanie statycznej analizy kodu na przykład z http://jshint.com, który w połączeniu z http://gruntjs.com i serwerem z funkcją livereload może nas powiadamiać o problemach w czasie rzeczywistym.

      Powyższy wpis ma na celu pokazanie sposobu pisania kodu łatwego do analizy przez współpracowników. Niekoniecznie chodzi tu o JavaSvript.

  2. Dla mnie osobiście prace zespołowe to koszmar – każdy ma swoje upodobania odnośnie wcięć, struktury, komentarzy czy odstępów. Nawet kiedy współtworzę coś z grupą znajomych ciężko jest zunifikować sposób pisania kodu. Pozdrawiam

    1. Warto na początku pracy z projektem ustalić pewne reguły, spisać je i podpiąć analizę kodu z naszymi regułami pod git. W ten sposób nie będzie można commitować źle sformatowanego kodu.

Dodaj komentarz

Twój adres email nie zostanie opublikowany. Pola, których wypełnienie jest wymagane, są oznaczone symbolem *