Dodatek B. Standardy kodowania Zend Framework

Spis treści

B.1. Wstęp
B.1.1. Zakres
B.1.2. Cele
B.2. Formatowanie plików PHP
B.2.1. Ogólnie
B.2.2. Wcięcie
B.2.3. Maksymalna długość linii
B.2.4. Zakończenia linii
B.3. Konwencje nazewnictwa
B.3.1. Klasy
B.3.2. Nazwy plików
B.3.3. Funkcje i metody
B.3.4. Zmienne
B.3.5. Stałe
B.4. Styl kodowania
B.4.1. Odgraniczanie kodu PHP
B.4.2. Łańcuchy znaków
B.4.2.1. Proste łańcuchy znaków
B.4.2.2. Proste łańcuchy znaków zawierające apostrofy
B.4.2.3. Podstawienia zmiennych
B.4.2.4. Łączenie łańcuchów znaków
B.4.3. Tablice
B.4.3.1. Tablice indeksowane numerycznie
B.4.3.2. Tablice asocjacyjne
B.4.4. Klasy
B.4.4.1. Deklaracja klas
B.4.4.2. Zmienne klas
B.4.5. Funkcje i metody
B.4.5.1. Deklaracja funkcji oraz metod
B.4.5.2. Użycie funkcji oraz metod
B.4.6. Instrukcje kontrolne
B.4.6.1. If/Else/Elseif
B.4.6.2. Instrukcja Switch
B.4.7. Dokumentacja
B.4.7.1. Format dokumentacji
B.4.7.2. Pliki
B.4.7.3. Klasy
B.4.7.4. Funkcje

B.1. Wstęp

B.1.1. Zakres

Ten dokument określa wytyczne dla programistów i zespołów tworzących Zend Framework lub tworzących aplikacje w oparciu o Zend Framework. Wielu programistów używających Zend Framework uważa też za przydatne te standardy kodowania ponieważ dzięki nim ich styl kodowania pozostaje zgodny z całym kodem Zend Framework. Warto też zaznaczyć, że określenie standardów kodowaia wymaga znacznego wysiłku. Uwaga: Czasem programiści uważają, że trzymanie się standardu jest ważniejsze od samej treści i idei standardu. Przewodnik po standardach kodowania Zend Framework pokazuje najlepsze praktyki jakie mogą być stosowane w projekcie ZF. Możesz modyfikowaćte standardy lub użyć ich w takiej postaci w jakiej są, ale musisz to zrobić zgodnie z licencją

Do poruszonych tematów należą:

  • Formatowanie plików PHP

  • Konwencje nazewnictwa

  • Styl kodowania

  • Dokumentacja

B.1.2. Cele

Standardy kodowania są ważne w każdym projekcie programistycznym, a szczególnie gdy przy tym samym projekcie pracuje większa ilość programistów. Standardy kodowania pomagają zapewnić wysokoą jakość kodu, mniejszą ilość błędów i łatwe zarządzanie.