PEAR Kodlama standartları PEAR’ın resmi web sitesinde açıklanmıştır. Bu açıklamaların bir kısmını Türkçeleştirip bu yazıda size sunmaya çalışacağım.

Satır uzunluğu ve girintiler
Yaklaşık olarak 75-85 karakter aralığında yeni satıra geçilmelidir.

Girintiler ise 4 karakter uzunluğunda ve boşluk karakteri ile oluşturulmalıdır. Girintiler ayarlanırken sekme (tab karakteri) kullanılmamalıdır. Kod yazdığınız düzenleyicinin ayarlarını sekme uzunluğu 4 karakter ve boşluktan oluşacak şekilde ayarlamanız tavsiye edilmektedir.

Kontrol İfadelerinin Yazılımı (IF, Switch)


Kod:
if ((koşul1) || (koşul2)) {
işlemler;
} elseif ((koşul3) && (koşul4)) {
diğer işlemler;
} else {
varsayılan işlemler;
}


Kontrol ifadeleri (if, for, while, switch …) yazılırken anahtar kelime ile parantez arasında bir boşluk olmalı ve mantıksal sınamaların yazımında her bir mantıksal ifade parantez ile ayrılmalı. Bu kodun okunabilirliğini artırdığı gibi mantıksal hataları yakalamanızı da sağlayacaktır.

Diğer bir örnek (Swicth)


Kod:
switch (koşul) {
case 1:
Eylem1;
break;
case 2:
Eylem2;
break;
default:
varsayılan eylem;
break;
}


İşlev Çağrılması
İşlev adı ile parantez arasında, ilk parametre ile parantez arasında ve son parametre ile parantez arasında boşluk olmamalı, parametreler birbirlerinden virgül ve boşluk karakteri ile ayrılmalı ve işlev tek bir satırda yazılıp noktalı virgül ile satır bitirilmelidir.

Örnek:


Kod:
$var = foo($bar, $baz, $quux);


Eşittir işareti ile işlev adı arasında bir boşluk olmalıdır, ancak kod okunurluğunun arttırılmasını sağlamak için duruma göre değişken adı ile eşittir işareti arasındaki boşluk miktarı artırılabilir.


Kod:
$kisa = foo($bar);
$uzun_degisken = foo($baz);


İşlev Tanımlama

İşlev tanımlamalarında kontrol ifadelerinden farklı olarak süslü parantez alt satırda yer alır.

Örnek:


Kod:
function ornekIslev($arg1, $arg2 = ”)
{
if (koşul) {
Eylem;
}
return $val;
}


Varsayılan değere sahip parametreler son sıralarda tanımlanmalıdır.

Biraz daha uzun bir örnek


Kod:
function connect(&$dsn, $persistent = false)
{
if (is_array($dsn)) {
$dsninfo = &$dsn;
} else {
$dsninfo = DB:arseDSN($dsn);
}
if (!$dsninfo || !$dsninfo[’phptype’]) {
return $this->raiseError();
}
return true;
}


Yorum Satırları

Yorum satırları phpDoc () standartına uygun yazılmalıdır.

Belge dışındaki yorum satırları standart C yorum satırları şeklinde olması tavsiye edilir (/* */ ve //) perl yorum satırı (#) benimsenmez.

Kod dahil etme (include, require)

Eğer bir sınıf (class) programa şarta bağlı olmaksızın dahil edilecekse require_once() kullanılmalıdır, ancak programın belli bir yerinde belli bir şarta bağlı olarak dahil edilmesi gerekiyorsa include_once() kullanılmalıdır.

Not: require_once() ve include_once() işlev değil ifadedir. Dolayısıyla eklenecek dosya adı parantez içerisinde yazılmaz.

Örnek


Kod:
require_once ‘PEAR.php’;


PHP etiketleri
PHP başlangıç ve bitiş etiketleri olarak <?php ?> kullanılmalı. Daha kısa olan <? ?> kullanılmamalıdır.