Kurs PHP - stwórz MMORPG Kurs PHP z ćwiczeniami i przykładami

Niby to dość dziwny tytuł jak na tego bloga, ale nie chodzi o styl pisania wypracowań, tylko styl pisania kodu. Czyli słów kilka na temat poprawności pisania kodu. Tak, żeby później było łatwo.

Wydaję się to błahostką, bo przecież nie ważne jak jest napisane, byleby działało. W sumie jest w tym dużo racji. O ile przy prostych skryptach jest to kwestia mało istotną, to przy większych stanowi konieczność (coś jest nielogicznego w tym zdaniu, ale nie wiem co:P ).

Przy napisaniu skryptu na 1,5 tysiąca linijek, chcemy zmienić jedną rzecz (jakąś drobnostkę) a bez poprawnie napisanego kodu, stracimy na to godziny. Czasami w takim wypadku jest szybciej napisać od nowa niż szukać.

Każdą nowo rozpoczętą funkcję, pętlę, jakąś instrukcję warunkową (czyli coś nie będzie wykonywane liniowo) piszemy po wcięciu. Można to było już zauważyć np. w poprzednim poście. Kod będzie wtedy przejrzysty.

Nazywajmy zmienne w taki sposób, żeby można było się domyślić jaka zmienna jest tam przechowywana, np. zamiast $cos_tam użyjmy $licznik. Nie będziemy musieli przeszukiwać całego kodu żeby się dowiedzieć do czego używaliśmy danej zmiennej.

Jeśli zaczniemy używać klas (o których będę pisał później) pamiętajmy żeby każda klasa była w osobnym pliku o takiej samej nazwie co klasa.

Jeśli linia jest za długo, spróbujmy ją jakoś podzielić. Nie będzie trzeba przesuwać obrazu w poszukiwaniu czegoś ważnego w linijce.

Na koniec komentarze. Są one bardzo istotne, ponieważ wracając do kodu po jakimś czasie nie pamięta się o co w nich chodziło (nie raz tak miałem). Komentarzy używa się następująco:

Używajmy ich przy opisaniu klas, metod funkcji (co robią, jakie mają zmienne i co zwracają) oraz w istotnych miejscach działania kodu (opisujcie co i jak się dzieje). Wiem, że komentarzy nie chce się pisać, bo każdy uważa, że będzie pamiętał co sam napisał. Uczcie się na moich błędach i piszcie komentarze.