Programcılık...? Dahilik mi? Büyü mü?

Transkript

1 Programcılık...? Dahilik mi? Büyü mü?

2 Neden Türkçe Açık Kaynak Bulmak Zor? Programcı Sayısı Yetersiz (?) İnsanlar kodlarını açıklamak istemiyor (?)...

3 PEAR'ın Getirdikleri PHP kullanıcıları için açık kaynaklı yapısal bir kütüphane Paket dağıtımı ve bakımı için sistem PHP dili için standart kod yazma biçimi PHP Extension Community Library (PECL) PHP/PEAR komitesi tarafından desteklenen web sitesi, ileti öbekleri, paketlerin indirilmesi için yansı adresleri

4 PEAR Standartlarında Kod Yazmanın Faydaları Kod okunurluğunun artması Ekip çalışmalarında kolaylık Zamandan tasarruf Daha az hata Otomatik belge hazırlanması (phpdoc ile) Disiplin

5 Satır uzunluğu ve girintiler Yaklaşık olarak 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.

6 Kontrol İfadelerinin Yazılımı (IF, Switch) PHP: 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) PHP: switch (koşul) { case 1: Eylem1; break; case 2: Eylem2; break; default: varsayılan eylem; break;

7 }

8 İş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: PHP: $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. PHP: $kisa = foo($bar); $uzun_degisken = foo($baz);

9 İşlev Tanımlama İşlev tanımlamalarında kontrol ifadelerinden farklı olarak süslü parantez alt satırda yer alır. Örnek: PHP: 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 PHP: function connect(&$dsn, $persistent = false) { if (is_array($dsn)) { $dsninfo = &$dsn; } else { $dsninfo = DB::parseDSN($dsn); } if (!$dsninfo!$dsninfo['phptype']) { return $this->raiseerror();

10 } } return true;

11 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.

12 Dosya Çağırma (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 : PHP: require_once 'PEAR.php';

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

14 Dosya Başı Yorum Satırları Bütün dosyalarda "sayfa seviyesi" (page level) yorum blokları sayfa başında yer almalı, "sınıf seviyesi" yorum satırları ise sınıf bildirisinin üzerinde yer almalıdır. Örnek: PHP: <?php /* vim: set expandtab tabstop=4 shiftwidth=4 softtabstop=4: */ /** * Dosya için kısa bir açıklama * * Eğer varsa dosya için daha uzun bir açıklama... * * PHP versions 4 and 5 * * LICENSE: This source file is subject to version 3.0 of the PHP license * that is available through the world-wide-web at the following URI: * If you did not receive a copy of * the PHP License and are unable to obtain it through the web, please * send a note to license@php.net so we can mail you a copy immediately. * Kategori adı

15 Paket adı Gerçek Yazar <yazar@example.com> Diğer Bir Yazar <digeri@example.com> php.org.tr PHP License 3.0 CVS: $Id:$ NetOther, Net_Sample::Net_Sample() File available since Release File deprecated in Release */ /* * Programa dahil edilmeler, sabit tanımlamaları ve $_GLOBAL * ayarları burada yapılmalı. * Yazdığınız yorum satırlarının phpdocumantor programına * uygun olduğundan emin olmalısınız. */ /** * Sınıf için kısa tanım. * * Eğer varsa sınıf için daha uzun tanım (açıklamalar)... * Kategori adı Paket Adı Gerçek Yazar <yazar@example.com> Diğer Bir Yazar

16 The PHP Group PHP License NetOther, Net_Sample::Net_Sample() Class available since Release Class deprecated in Release */ class foo { }?>

17 Dosya Başı Yorum Satırlarında Kullanılması Zorunlu Etiketler Kısa Açıklama : Kısa açıklama satırı bütün açıklama bloklarında yer almak zorundadır. Kısa açıklama satırı işlev, sınıf veya dosyanın adı olmamalı, ilgili nesneyi kısaca tarif edecek şekilde yapılmalıdır. Lütfen örnek dosyayı inceleyiniz. PHP Sürümü : Aşağıdaki satırlardan birtanesi "dosya seviyesi" yorum bloğunda yer almak zorundadır. PHP: * PHP version 4 * PHP version 5 * PHP versions 4 and : Pek çok açık kaynak lisans biçimi vardır. Aşağıdakilerden birisi "dosya seviyesi" ve "sınıf seviyesi" yorum bloklarında yer almak zorundadır. (PEAR için kod yazıyorsanız eğer..) PHP: Apache License BSD License (2 Clause) BSD License (3 Clause) BSD License (4 Clause) LGPL License 2.1

18 PHP License 3.0 Lisans ile ilgili daha fazla bilgi için PEAR grubunun Lisans bildirilerine : PEAR için yazılan programlarda aşağıdaki satır bulunmak zorundadır. PHP:. : Programa katkıda bulunan yazarların kaynak kodda yer almasıyla ilgili katı bir kural yoktur. Genellikle %10-%20 oranında programın değişmesini sağlanması veya bazı işlevlerin yeniden yazılması veya programa yeni bir mantık katılması kişiyi yazar listesine dahil etmek için yeterli : Programın çıkarılan ilk sürümünden sonra kullanılması gerekir. İlgili dosyanının veya sınıfın hangi sürümden itibaren olduğunu belirtir. Programın çıkarılan ilk sürümünde bu etiket yer : Eğer dosya veya sınıf ilerki sürümlerde kullanılmaması planlıyorsa yazılması gerekir.

19 Dosya Başı Yorum Satırlarında Kullanılması İsteğe Bağlı : Telif hakkı bilgisini bildirir. Bu bilgiyi nasıl ekleyeceğinizde serbestsiniz. Kişi listesi, bir şirket ismi, belli bir gurup ismi yazabilirsiniz. Eğer yıl kullanacaksanız 4 haneli olmalı. Aşağıdaki örnekleri inceleyiniz. PHP: Sinan YALÇINKAYA ve Tufan ÖZSOY Sinan YALÇINKAYA POT KRC Bilişim Lisans Özeti : Eğer PHP lisansıyla yazacaksanız yukardaki örneği olduğu gibi kullanabilirsiniz. Veya isteğinize göre bir lisans dosyası yazabilirsiniz. Dikkat etmeniz gereken şey yazdığınız lisans dosyasının LICENCE: şeklinde : Nesne ile ilgili olan diğer nesnelere (sınıf, dosya, işlev, değişken...) atıfta bulunurken kullanılır. Birden etiketi yazmaktansa bağlantılı olan nesneleri virgül ile ayırıp yan yana yazmak tavsiye edilir.

20 Örnek Adresler Bütün örnek adresler rfc2606 standartına göre example.com, example.org ve example.org şeklinde verilmelidir.

21 İsimlendirme Sınıflar : Sınıf isimleri büyük harf ile başlamalı, mümkün olduğunca kısaltma kullanılmalıdır. Sınıf hiyerarşisi içerisinde her bir alt seviye tek bir alt çizgi işareti ile ayrılmalıdır. Örnek: Log Net_Finger HTML_Upload_Error İşlevler : İşlev isimleri kısaltmalar hariç küçük harf ile başlayıp devam eder, ancak yeni bir kelimeye geçeceksek sınıf isimlerindeki gibi alt çizgi kullanmak yerine yeni kelimenin ilk harfini büyük yazarız. Örnekler: baglan() verial() birseyleryap() XML_RPC_serializeData() Sınıfa ait "özel" (sadece sınıf tarafından kullanılacak) işlevler isimlendirilirken ilk karakter olarak alt çizgi kullanır ve işlev isimlendirme kurallarına göre isimlendiririz. Örnekler: _sort() _inittree() $this->_status

22 Sabitler : Sınıf isimleri her zaman büyük harflerle yazılmalı ve her bir kelime alt çizgi ile birbirinden ayrılmalıdır. Sabitlerin ön ekleri daima ilgili paketin adı ile başlamalı ve alt çizgi ile diğer kelimeden ayrılmalıdır. Örneğin PEAR'ın DB:: paketine ait bütün sabit isimleri DB_ ile başlamalıdır. Not: true, false ve null sabitleri diğerlerinden ayrı olarak daima küçük harflerle yazılmak zorundadır. Global Değişkenler : Eğer paketiniz global değişkenler kullanacaksa bu değişkenler alt çizgi, paketin adı ve tekrar alt çizgi ile başlamalıdır. Örnek olarak PEAR paketi aşağıdaki gibi bir global değişken tanımlamıştır. PHP: $_PEAR_destructor_object_list

23 Dosya Biçimi PEAR için yazılacak her program dosyası aşağıdaki niteliklerde olmalıdır. * ASCII text olarak kaydedilmeli. * ISO karakter kodlamasıyla kaydedilmeli. * Unix dosya biçimi şeklinde olmalı. Unix dosya biçiminden kasıt satırların LR özel etiketi ile bölünmesi, windowsta olduğu gibi CLRF veya machintosh da olduğu gibi CL ile değil. Ve dosyanın en son karakterlerinin?> olması (PHP bitiş etiketinden sonra her hangi bir boş satır veya boşluk vs... olmamasına dikkat etmelisiniz)

24 Bağlantılar

25 Kodlama Disiplini Kod Örnekleri Tavsiyeler Tartışma

26 Çirkin Kodlara Örnekler (En Büyük Düşmanlarımız) Kuralsızlık Kuralı Kopyala-Yapıştır Sıkıştıkça IF Kullan

27 Sonuç Tutarsızlık Daha Fazla Sayıda IF Daha Fazla Sayıda Sorun