Ground rules – jak DOBRZE pisać kod?

Kod może napisać każdy, jeśli włoży trochę wysiłku w naukę programowania. Może uczyć się tego samodzielnie, w grupie, czy pod okiem mentora. Jednak pisanie dobrego kodu, to już wyższy poziom wtajemniczenia. Dlatego dzisiaj chcę dać Wam kilka reguł na to, jak DOBRZE kodować.

Przepis prosto z Akademii, w jaki sposób dobrze pisać kod 🙂 

Są to absolutnie bazowe zasady, które wtłaczam w głowy studentów od pierwszego spotkania, i które wyróżniają ich później na rynku pracy. To dzięki nim są w stanie pisać kod lepszej jakości. 

Co do kolejności – nie ma ona znaczenia, jest zupełnie losowa. Każde z jedenastu przykazań jest tutaj jednakowo ważne 😉

Lista 11 zasad:

nr 0 

Praca zaczyna się jeszcze zanim zabierzesz się za kodowanie. Nim napiszesz swój kod, poświęć chwilę na planowanie. Weź kartkę, IDE, bądź wirtualną tablicę i staraj się rozrysować lub rozpisać (jak Ci wygodniej) cały proces, który masz zrealizować w kodzie. Zawrzyj tam informacje, co dokładnie chcesz zrobić. Jedna godzina rysowania zaoszczędzi Ci wiele godzin kodowania „na ślepo”.

nr 1 

Warto zapamiętać, że walidacja zawsze ma trzy rodzaje – walidacja na:

  • typy – jakiego argument/zmienna jest typu – typeof xyz === ‘string’
  • wartości – jaki jest zbiór wartości każdego argumentu, index >= 0 && Number.isInteger(index
  • logikę biznesową – czyli reguły biznesowe, wg których dany proces ma działać

W większości zadań/tasków przewijają się wszystkie trzy rodzaje walidacji. 

nr 2 

Gdy już napiszesz kod, przeczytaj go sobie na głos (zmienne i funkcje + czasem słowa kluczowe). Dlaczego? To prosty test jego jakości. Jeśli będziesz gadać jak komputer, to jest to słaby kod. A jeżeli zaczniesz mówić zdaniami po angielsku, to jesteś na dobrej drodze do lepszego kodu!

nr 3 

Zawsze traktuj przyszłych użytkowników Twojego kodu… jak idiotów. Szczególnie samego “siebie z przyszłości”. Dlaczego? Takie myślenie pozwala dopracowywać kod do formy naprawdę niezawodnego rozwiązania. A o to nam chodzi, prawda? 

nr 4 

Zaczynasz się gubić we własnym projekcie? To znaczy, że to czas na refactor kodu czy struktury! Jeśli masz opory, pamiętaj, że celem refactoru nie jest wytwarzanie czegoś nowego, ale utrzymywanie odpowiedniej jakości w tym, co już masz

nr 5 

Zasada, która sprawia, że Twój kod z każdym commitem jest lepszy. Za każdym razem gdy wchodzisz w kod, zrobić jakiegoś taska, wychodząc z niego zostaw jego otoczenie w trochę lepszym stanie niż zastałeś. To nawyk najlepszych programistów!

nr 6 

Ważny punkt w odniesieniu do poprzedniego. Zawsze znajdzie się miejsce na usprawnienia i podnoszenie jakości kodu i środowiska, w którym piszesz. W związku z tym kod można ulepszać tak naprawdę w nieskończoność – a i tak możesz nigdy nie odczuć, że osiągnąłeś “perfekcyjną formę”. Dlatego pamiętaj, aby był zawsze po prostu good enough.

nr 7 

Musisz użyć komentarza, aby coś zrozumieć w kodzie? To cenna informacja, która krzyczy do Ciebie “to jest słaby kod!”. Zrób coś z tym. Zmień coś w kodzie, zamiast dopisywać notatki. [No, chyba, że to RegExp – to nieco inna bajka, bo nie każdy mówi w hieroglifach]

nr 8 

Miej świadomość, że angielski to uniwersalny język pisania kodu. W związku z tym, znajomość składni i słówek uczyni Twój kod czytelniejszym. Warto poświęcić trochę czasu w tygodniu na naukę, jeśli nie czujesz się w tym języku zbyt pewnie.

nr 9 

Nie myśl o tym, JAK coś nakodzić! Myśl o tym, CO chcesz zrobić przy pomocy kodu. Skup się na celu i rozwiązaniu, jakie chcesz tworzyć. Jakie kod ma mieć zastosowanie? To podstawa, którą należy mieć na uwadze.

nr 10 

Paradygmat obiektowy i funkcyjny są często równie dobre w rozwiązywaniu problemów, o ile są poprawnie używane. Jednak najczęściej najlepsze rezultaty to te uzyskane dzięki stosowaniu stylu mieszanego.

nr 11

Ostatnia, dodatkowa zasada, zaproponowana przez jednego z naszych obserwatorów na facebooku 🙂 – “Jeśli masz taką możliwość, używaj linterów kodu (eslint, prettier), wtedy nie musisz się przejmować tym, że Ty i Twoi koledzy macie inną konfiguracje stylowania 🙂”.

Zrozumienie tych kilku zasad i uświadomienie sobie ich potencjału pozwoli Ci pisać kod lepszej jakości każdego dnia – i wyróżnić się na rynku pracy!

Masz jakieś swoje “złote zasady”, które zawsze stosujesz przy pisaniu kodu i chcesz się nimi podzielić? Możesz zrobić to w komentarzu TUTAJ. Lista bazowych zasad może się wydłużyć!

contact

Wahasz się? Podaj nam swojego maila i umów się z naszym mentorem na niezobowiązującą konsultację.