Standardy kodowania.

Podobnie jak "fizyczna" część aplikacji, część logiczna także powinna się stosować do określonych konwencji. Klasy, funkcje i zmienne powinny być nazwane w logiczny sposób tak, aby ich nazwy dobrze oddawały naszą intencję. Logiczna część aplikacji to nic innego jak kod, więc przejdźmy do przykładów. Na początek przyjrzyjmy się przykładowi, który po prostu źle obrazuje intencję i psuje czytelność:

<?php
 $_X = foo(2);
 print $_X;
 
 function foo($bar) {
 return $bar * $bar; }
?>

Chociaż jest to czysto akademicki przypadek, dobrze prezentuje omawiany problem. Zmienna "$_X" i funkcja "foo" wcale nie oddają ich celu - aby dowiedzieć się, co zostanie wyświetlone na ekranie, musisz się przyjrzeć kodowi funkcji. Wyobraź sobie, że funkcja "foo" implementuje skomplikowany algorytm i może zwracać różnorakie kody, w zależności od ewentualnego wystąpienia błędu. Musiałbyś w takiej sytuacji studiować kod linijka po linijce, aby dowiedzieć się, o co tak naprawdę chodzi.

Przykład ten jest wadliwy w kilku innych aspektach. Zawiera beznadziejnie sformatowany kod wewnątrz funkcji "foo". Na dodatek, nazwanie zmiennej wielkimi literami, sugeruje, że zmienna jest albo stałą(:D), albo zmienną superglobalną, co w tym przypadku jest nieprawdą. Rozważ ulepszoną wersję naszego przykładu:

<?php
 $myNumber = 2;
 $mySquaredNumber = square($myNumber);

 function suqare($number)
{
  return $number * $number;
}
?>

Oprócz znacznie większej czytelności kodu, nazwy zmiennych i funkcji są jasne i oczywiste jest, co robi kod, nawet nie czytając definicji funkcji. Nazwy zmiennych są sformatowane podobnie jak nazwy plików - każde nowe słowo rozpoczynane jest wielką literą - to sprawia, że łatwo się je czyta i wpisuje. Klamerki w definicji funkcji są w pojedynczych liniach, co zwiększa czytelność definicji funkcji. Ponadto, kod w klamerkach zawsze powinien być poprzedzony jednym tabulatorem, aż do zamykającej klamerki. Rozważmy jeszcze jeden przykład, zanim odczytamy kompletną listę konwencji kodowania:

<?php
 print new foo_class(2);
 
 class foo_class{
 function foo_class($foo) { return $foo * $foo; }}
?>
<literal>

Ten przykład jest jeszcze gorzej sformatowany niż poprzedni. Na początek, użycie klasy w takim kontekście jest bezsensowne i całkowicie nie na miejscu. Poza tym, nazwa klasy nam nic nie mówi, a konstruktor jest użyty do zwracania kwadratu liczby. Jest to kolejny raczej akademicki przykład, ale jestem pewien, że większość programistów widziała kiedyś taki kod - nigdy nie jest łatwo patrzeć na takie "coś". Replay!(ulepszony):
<literal class='php'>
<?php
 $myNumber = 2;
 $myNumberSquared = Math::square($myNumber);
 print $myNumber;
 
 class Math 
 {
  function square($number)
  { 
   if (is_numeric($number) == false)
   {
    return 0;
   }
   
   return $number * $number;
  }
 }
?>

Powyższy przykład zajmuje dużo więcej miejsca na ekranie, ale jest ale jest zdecydowanie milszy dla oka. Zmienne mają teraz jasne nazwy, precyzyjnie określające ich cel. Nazwa naszej klasy, inaczej niż w przypadku zmiennych lub funkcji, rozpoczyna się wielką literą. Klasy powinny mieć nazwy w omawianym wcześniej formacie, ale z pierwsza litera powinna być wielką - to pozwala na łatwe zauważenie, w którym miejscu używana jest klasa, a także wysokie umiejscowienie klasy w hierarchii aplikacji.

Kod wewnątrz klasy jest starannie zagnieżdżony, a każda klamerka umieszczona jest we własnej linii, co pozwala łatwo odróżnić poszczególne bloki kodu. Przykład dodaje nawet prostą formę weryfikacji argumentów metody "square" - sprawdza, czy argument jest liczbą, czy można go podnieść do kwadratu. Zauważ przeprowadzanie właściwego testu na wartości zwracanej przez funkcję "is_numeric", unikając w ten sposób używania zwartej logiki. Wrócimy do tego w dalszej części.

Aby podsumować zastosowane konwencję, przygotowałem prostą listę zasad:

1. Zmienne powinny posiadać adekwatne do swojego przeznaczenia nazwy, zaczynające się z małej litery, używające formatu omówionego przy okazji nazewnictwa plików.

2. Klasy powinny posiadać intuicyjne nazwy, dobrze opisujące ich przeznaczenie, powinny używać tego samego formatu co zmienne, tyle że pierwsza litera ich nazwy powinna być literą wielką.

3. Funkcje powinny być nazywane według tych samych zasad co zmienne, podobnie ich argumenty.

4. Klamerki winny pojawiać się w osobnych liniach, a kod w nich zawarty powinien być zagnieżdżony(1 tabulator).

5. Nazwy stałych powinny być zapisane w całości wielkimi literami.

6. Właściwości klasy obowiązują te same zasady co zwykłe zmienne. Ponadto, do zmiennych klasy nie powinno się odwoływać z zewnątrz klasy - unikniemy wtedy pomyłek podczas odwoływania się do metod - które niekiedy mają takie same nazwy jak właściwości klasy. W PHP5 problem ten znika - można tam bowiem określić widoczność elementów klasy.

7. Klasy, funkcje i zmienne nie powinny być niepotrzebnie dodatkowo nazywane. Na przykład: funkcja nie powinna się nazywać "fn_square", a klasa z kolei nie powinna się nazywać "MathClass".