Standardy kodu PHP w Ageno

Dobre praktyki formatowania kodu PHP

Wpis powstał na wewnętrzne potrzeby developerów Ageno.pl. Może być jednak szeroko rozpowszechniany w celach doskonalenia swoich umiejętności.

Do pobrania

• Gist z konfiguracją formatowania kodu

Macro z formatowaniem i zapisem

1. Edit > Macros > Start Macro Recording
2. Code > Reformat Code
3. File > Save All
4. Edit > Macros > Stop Macro Recording
5. Nazwa: “Reformat code and save”
6. Preferences > Keymap > Wyszukaj “Reformat code and save”
7. Ustaw skrót ⌘ + S (nadpisując domyślny Save All)

Podsumowanie szkolenia

Tabulacje

• znak spacji
• rozmiar: 4

Spacje

• Przed otwarciem instrukcji if, for, while, switch, catch
• Przed i po operatorach (m.in. = && => .)
• Przed lewostronnymi nawiasami {
• Przed słowami kluczowymi (else, while, catch, finally)
• Po “:” przy deklaracji typu wyjścia funkcji
• Po negacji (! )

Nawiasy

• W następnej linii (definicja klas, metod)
• Na końcu linii (przestrzenie nazw, warunki, pętle)

Zawijanie

• Prawy margines 120 kolumn
• Zawijanie długich linii: metody łańcuchowe, instrukcje warunkowe, definicje tablic, argumenty funkcji, parametry funkcji

Wywołania metod łańcuchowych

• W przypadku dłuższych struktur, kolejne wywołania zaczynamy od następnej linii

Puste linie

• Dozwolona 1 linia odstępu
• Linia odstępu przed instrukcją return

Pozostałe wytyczne

• Lowercase dla true, false, null
• Instrukcja elseif pisana razem
• Krótka notacja tablicy
• Przecinek za ostatnim elementem tablicy