14
Temmuz
2016
0 yorum

PHPDOC Kullanımı ve Etiketler

Merhaba arkadaşlar bugün sizlere phpdoc kullanımını ve bir kaç sık kullanılan etiketini tanıtacağım. Öncelikle neden phpdoc kullanıyoruz ?  hemen bunu açıklayalım. Her şeyden önce düzen için kullanıyoruz denile bilir özellikle opensource projeleri inceliyor iseniz etiketleri sıkça görürsünüz burada etiketlerde versiyon bilgisi geliştirmen bilgisi yada fonksiyon ve metotlardan geri dönecek değer veya alacak parametreler ve türleri gibi bilgiler bulunuyor kısaca toparlamak gerekir ise bir dosyayı ( sınıfı ) açtığınız zaman metotlara bakarken oturup bütünü ile metot’u incelemenize gerek kalmaz hemen pratikçe kullanımını kavramanıza olanak sağlar ayrıca açıklama satırlarında ki notlar gibi değerlerde bunlara artı diye biliriz kısacası aslında açıklama satırlarının gelişmiş hali diye biliriz.

Ek olarak ise dökümantasyon oluşturmanıza olanak sağlar ( Bunu daha sonra size online olarak kullanımı ile açıklayacağım şimdilik es geçiyorum ) 

Sık Kullanılan etiket listesi

  • @author ( Geliştirmen bilgisi genelde mail adresi’de <> arasında belirtilir )
  • @access ( Erişim metodu)
  • @copyright ( Lisanshakkı bilgisi)
  • @deprecated (Terk edilmiş metot/sınıf/nesne)
  • @example (Kullanım örneği / içeren dosya adresi vs..)
  • @var ( Değişken tipi )
  • @link ( Döküman içerisinde bağlantı adresi  )
  • @see ( Dökümanda x bir şey kullanıyor iseniz daha doğrusu başka bir şeye göz atması gerekiyor ise see değeri ile yönlendire bilirsiniz bakınız olarak düşüne bilirsiniz.)
  • @since ( Belirli bir versiyondan buyana kullanılıyor şeklinde kullanılır)
  • @param ( Metot/fonksiyon parametresi)
  • @version ( Versiyon / Sürüm bilgisi )
  • @return( Metot/fonksiyon  geri dönen değer tipi örnek : int,array[],string,null vs.. )

Örnek

Sizler için insan adı altında saçma sapan bir sınıf hazırladım örneği inceleye bilirsiniz x)

Daha detaylı canlı örnek => https://github.com/saltun/sBotClass

[ Benzer Yazılar ]
  • Türkiye saat tarih ayarı Asia/Qatar


    Merhaba arkadaşlar eskiden bildiğiniz gibi Avrupa / İstanbul zaman dilimini kullanıyorduk lakin artık Asya / Katar zaman dilimine geçm...
  • PHP Sınıf ismini alma


    Merhaba arkadaşlar oluşturduğunuz sınıf içerisinde sınıfın adını almak istiyorsanız bunun için php de get_class() fonksiyonunu...
  • PHP Türeten sınıf adını alma


    Merhaba arkadaşlar bugün sizlere türetilen bir sınıfta nasıl onu türeten sınıfın adını alacağınızı anlatacağım bunun için...
  • PHP Rastgele Tarih oluşturma


    Merhaba arkadaşlar php ile iki tarih arasında nasıl random tarih oluştura bileceğiniz en basit şekilde anlatacağım ilk olarak unix f...

Ben Kimim ?
Savaş Can ALTUN
Merhaba ben Savaş Can ALTUN bana kısaca Savaş diye bilirsiniz. Özel bir şirkette yazılım geliştirici olarak çalışıyorum genel olarak web programlama ile ilgileniyorum buna ek olarak freelance çalışyıorum blog'um da karalamalarımı bulabilirsiniz benimle iletişime geçmek için alttaki sosyal medya adreslerini kullana bilirsiniz.
Arama
Facebook Sayfam
Yazılara Abone Ol !