kod

Jak napisać dobry kod?

Jak napisać dobry kod?

Planuj swoje działania.

Postaw sobie cel jaki chcesz osiągnąć na koniec swoich działań. Za nim zaczniesz pisać kod warto sobie zadać kilka pytań: Co jest przedmiotem twoich działań? Jakich technologii najlepiej użyć do rozwiązania danego problemu? Jak osiągnąć swój cel?

Określaj funkcjonalność jaką ma spełniać twój kod. Jeżeli nie zrobisz tego wcześniej w przyszłości może się okazać, że kod będzie wymagał dużo przeróbek lub zmian. W trakcie trwania projektu lub pisania kodu czasem mogą następować jakieś zmiany założeń lub wymogów dlatego im twój kod będzie bardziej elastyczny i uniwersalny tym lepiej.

 

 

Przyjazny kod dla ciebie i innych.

Dany program powinien działać – jest to podstawa osiągnięcia swojego celu. Staraj się pisać czytelny i zrozumiały kod, bardzo istotnym elementem jest stosowanie komentarzy w kodzie. Odpowiedz sobie na pytanie: Czy dzisiaj napisany przeze mnie kod, będzie zrozumiały dla mnie za miesiąc? Często zdarza się, że po dłuższym czasie gdy wracamy do jakiegoś fragmentu kodu, nawet jeżeli został on napisany przez nas zastanawiamy się o co tam w ogóle chodziło.

Wyobraź sobie, że do projektu dołącza kolejny programista i jest potrzeba rozbudowy aplikacji o nowe funkcjonalności. Jeżeli nowa osoba zajrzy w twój kod może być jej ciężko tak od razu zrozumieć o co tam chodzi, ale gdy będą tam komentarze może szybciej zrozumieć co się w nim dzieje i to zaoszczędzi sporo czasu.

 

Nazwy zmiennych, funkcji, procedur.

Podczas tworzenia zmiennych lub funkcji trzymaj się wcześniej ustalonego nazewnictwa. Jeżeli przyjmujesz lub przyjmujecie w grupie ludzi, że wszystkie funkcje zaczynacie od małej litery to dobrze jest się trzymać tej zasady przez cały czas tworzenia programu. Takie podejście do tematu sprawi, że kod stanie się łatwiejszy w zarządzaniu.

Praca w grupie jest dość specyficzna, i dobrze jest za nim podejmiemy jakiekolwiek działania ustalić kto czym się zajmuje, rozdzielić obowiązki i ustalić spójny format i sposób pisania kodu aplikacji.

Dobrze jest też stosować takie nazwy procedur czy funkcji, aby po jej nazwie można było się domyśleć co ona robi. Łatwiej na pewno jest się domyśleć sposób działania funkcji o nazwie: dodajProdukt() niż dodPrd().

 

Formatowanie kodu.

Stosuj wcięcia w swoim kodzie – sprawi to, że będzie bardziej czytelny i przejrzysty. Dzięki strukturze wcięć i akapitów poprawi się zrozumienie funkcjonalności kodu w przyszłości. Gdy jakaś linijka kodu zaczyna być bardzo długa podziel ją na kilka linijek – taki prosty zabieg może sprawić, że analiza kodu jest łatwiejsza i szybsza, gdyż od razu widzimy co się dzieje i nie ma potrzeby skrolowania kodu w bok ekranu.

 

Który kod wydaje się bardziej czytelniejszy?

   

 

Struktura projektu.

Warto jest dzielić pisany kod na pliki i moduły w zależności od funkcjonalności jakie spełnia.

Zawsze dobrze jest zakładać, że nasz kod trzeba będzie rozbudować w późniejszym czasie. Takie myślenie i postępowanie sprawi, że możemy uniknąć frustracji gdy nagle się okaże, że będzie trzeba w naszym programie bardzo dużo zmienić i dodać jakieś nowe funkcjonalności. Twoim głównym celem powinno być organizowanie kodu tak, aby łatwo było wprowadzać w nim poprawki.

 

Debugowanie kodu.

Pisząc kod każdy popełnia błędy czy pomyłki nie sposób tego uniknąć. Stosowanie metody prób i błędów na dłuższą metę i przy dużym projekcie mija się z celem. Co więc zrobić, aby szybko znaleźć błąd i go wyeliminować? Z pomocą przychodzą nam wszelakie narzędzia do debugowania kodu.

Takie narzędzia umożliwiają nam np. zatrzymanie działania programu w jakimś momencie i sprawdzeniu aktualnego stanu zmiennych, lub zbadania miejsca, w którym aplikacja rzuca wyjątek i przerywa swoje dalsze działanie.

 

 

Wersje kodu.

Dobrą praktyką, zwłaszcza przy większych projektach jest stosowanie systemu wersjonowania kodu. Może się okazać, że w trakcie pracy nad projektem trzeba będzie wrócić do jakiegoś stanu kodu np. z przed tygodnia bo znaleźliśmy w obecnym kodzie jakiś bardzo rażący błąd.

Także podczas pracy grupowej system kontroli wersji jest nam bardzo pomocny, bo dzięki niemu kilka osób może pracować np. nad jednym modułem aplikacji, ale pisząc różne fragmenty kodu tego modułu odpowiedzialne za różne funkcje. Na rynku istnieje wiele systemów kontroli wersji kodu, miedzy innymi: Git czy SVN.

Posted by superkoder in Programowanie