Formatowanie kodu PHP

Formatowanie kodu

Reguły formatowania kodu źródłowego programów wpływają na czytelność i niejednokrotnie pozwalają uniknąć błędów programistycznych. W poszukiwaniu jasnych zasad, jakie powinno się stosować, pisząc skrypty w języku PHP, należy w pierwszej kolejności odwiedzić strony projektu PEAR. Pod adresem http://pear.php.net/manual/en/... znajdziesz dosyć dokładny opis wymagań nakładanych na kod rozpowszechniany w ramach projektu PEAR. Zasady te są oparte w znacznej mierze na standardzie ustanowionym przez książkę pt. "Język C" autorstwa Briana Kernighana oraz Denisa Ritchiego.

Zasady formatowania kodu PHP zostały szeroko opisane w dokumentacji biblioteki PEAR dostępnej pod adresem http://pear.php.net/manual/en/standards.php Ponieważ opis formatu zawarty we wspomnianym dokumencie nie jest kompletny (tj. nie porusza wszystkich zagadnień dotyczących programowania w PHP), trzeba się posłużyć dodatkowymi źródłami.

Dobrym rozwiązaniem jest analiza kilku wybranych aplikacji napisanych w PHP i cieszących się uznaniem środowiska programistów PHP. Aplikacjami takimi są między innymi phpBB, SquirrelMail, Tiki-wiki, Mambo czy typo3. Wprawdzie format wymienionych programów jest bardzo niespójny, ale analiza wybranych fragmentów w połączeniu ze standardami kodowania PEAR pozwoli na rozstrzygnięcie wszystkich wątpliwych kwestii.

Zagadnienia ogólne

Format pliku

Podstawowe wymagania dotyczą formatu pliku. Skrypty sformatowane zgodnie z zaleceniami projektu PEAR powinny być zakodowane jako iso-8859-1. Oznacza to, że polskie znaki diakrytyczne należy zapisywać w postaci xb1, na przykład w napisie "żółć":

 

 

PHP

echo "xbfxf3xb3xe6";

Ponadto znaki złamania wiersza należy zapisywać w formacie u*ix, czyli jako znaki LF o kodzie ASCII 10 (znaki n).

Długość linii kodu

Kto wie, czy nie najtrudniejszym problemem do rozwiązania jest ustalenie zasad łamania wiersza. Świadczy o tym chociażby fakt, że główne pakiety zawarte w bibliotece PEAR (z PEAR oraz DB na czele) stosują bardzo często wiersze o monstrualnej długości sięgającej nawet kilkuset znaków! Ten sam zarzut dotyczy zresztą wielu innych pakietów i aplikacji, w tym wszystkich wcześniej wymienionych: phpBB, SquirrelMail, Tiki-wiki, Mambo i typo3.

Tabela 1. Zależność liczby znaków wiersza od wielkości kroju czcionki oraz marginesów Długość wiersza nie powinna przekraczać 80 znaków. Przemawiają za tym dwa powody. Po pierwsze, analiza wiersza, który nie mieści się cały na ekranie, jest utrudniona. Po drugie, jeśli ktoś zechce kod o długich liniach wydrukować, efekt będzie godny pożałowania!

Tabela 1 przedstawia liczby znaków w wierszu, jakie zmieszczą się na wydruku. Ze wzrostem wielkości kroju czcionki oraz marginesów liczba ta oczywiście maleje. Stosując czcionkę wielkości 10 punktów i margines mniejszy niż 2,5 cm można na stronie zmieścić od 80 niemalże do 100 znaków.

Warto dodać, że do wydruku kodu programów komputerowych stosuje się czcionkę nieproporcjonalną, czyli taką, w której każdy znak ma stałą szerokość, na przykład Courier. Użycie czcionki proporcjonalnej, jak na przykład Arial, Verdana czy Times New Roman, powoduje, że wcięcia kodu oraz białe znaki są niezauważalne, zaś cały kod wygląda po prostu źle.

Tabulatory kontra spacje

Do wcinania kodu należy stosować znaki spacji. Tabulatory są znakami zależnymi od bieżącego kroju czcionki. Wcięcia wykonane tabulatorem mogą ulec zmianie w przypadku zmiany wielkości czcionki. Standardy kodowania biblioteki PEAR zalecają stosowanie czterech spacji do wcinania kodu.