12 stycznia 2019

Dobre praktyki programistyczne cz.2

Zapraszam do zapoznania się z częścią 1 serii dobrych praktyk programowania. W tym wpisie opiszę kilka elementów o których warto pamiętać programując w php.

O czym warto pamiętać:

Kodowanie

Tworząc nowy plik php w którym zamierzamy pisać, warto aby jego kodowanie było: UTF-8 bez BOM

Charakter pliku

Jeden plik php powinien być przeznaczony do jednej rzeczy. tzn nie może wywoływać metod i deklarować ich jednocześnie. Nie może służyć do ustawień aplikacji (deklaracji ustawień) i jednocześnie renderowania itd.

Jednocześnie pamiętaj, jeden plik = jedna klasa (nie więcej

Namespace

Każdy plik w którym piszemy klasę powinien posiadać również namespace.

Nazewnictwo

Nie muszę oczywiście tłumaczyć, że zmienne, funkcje, klasy nazywamy odpowiednio.

Odpowiednie nazewnictwo to takie gdzie nazwa zmiennej opisuje to co się w niej znajduje.

Nazwa klasy opisuje to do czego służy owa klasa. Nazwa metody opisuje to co robi dana metoda.

Ponadto, nazwy klas piszemy zgodnie z zasadą: StudlyCaps.
Nazwy metod piszemy zgodnie z zasadą: camelCase.
Nazwy stałych piszemy wielkimi literami.
Nazwy zmiennych podobnie jak nazwy metod: camelCase.

Podsumowanie:

Jeśli nie zgadzasz się z powyższymi zaleceniami, masz do tego prawo. Pamiętaj jednak abyś był konsekwentny w tym co robisz. Możesz zaczynać nazwy klas z małej litery, ale powinieneś w ten sposób nazywać wszystkie klasy w swoim projekcie.