PHP Dersleri #16 – Açıklama ve Dokümasyon Satırları


kodportali.comPHP derslerine kaldığı yerden tüm hızıyla yerleşik sabitler ile devam ediyoruz.

PHP ‘de Açıklama Satırları

Açıklama Satırı Nedir, Ne İşe Yarar?

Bildiğiniz gibi nerdeyse tüm programlama dillerinde açıklama satırı yani yorum satırı bulunuyor. Yorum satırları kodumuzdaki bazı yerlerde açıklama yapmak veya not bırakmak için veya kullanılıyor. Koda herhangi bir etkisi bulunmuyor.

Açıklama Satırı Nasıl Oluşturulur?

Operatörİşlevi
//Kısa açıklamalar için kullanılır.
#Yukarıdaki operatör ile aynı işlevi görür kısa açıklamalar için kullanılır.
/**/Bu daha uzun açıklamalar yapmak için kullanılır.

Yukarıdada göründüğü gibi toplam 3 farklı şekilde açıklama satırı oluşturulabilir.

Hadi Açıklama Satırı Oluşturalım!

Yukarıdaki örneğimizdede gördüğünüz gibi yorum satırlarını kullanarak kodumuzu açıkladık. Ve bu yorum satırları koda herhangi bir etki etmedi. Kodumuzu çalıştırdığımız zaman ekrana 4 yazdıracaktır.

PHP ‘de Dokümasyon Satırları

Dökümasyon Satırları Nedir, Ne İşe Yarar?

Dokümasyon satırları adı üstünde olduğu gibi kod hakkında, o sınıf, method veya herhangi bir şey hakkında dökümasyon sağlar. Bu dökümasyonlar IDE’ler tarafından kodunuzun analizi, veri giriş çıkışı kontrolü vb. işler için kullanılır. Aynı zamanda eğer herkese açık bir şey yapıyorsanız veya yaptığınız şeyi tek başınıza geliştirmiyorsanız diğer yazılımcıların da anlaması için kullanılır. Yani diğer insanlara dökümasyon sağlar. Dökümasyon satırlarının bir kaç minik kuralı bulunur ve bazı etiketlere sahiptir. Aynı zamanda yorum satırındaki gibi koda etkisi yokdur. Dökümasyon satırları /** ve */ arasına yazılır. Yorum satırındaki ile karıştırmayın sakın.

Dökümasyon Satırı, Etiket Listesi

EtiketElementAçıklama
apiMetod (Yöntem)Elemanların üçüncü taraflarca tüketilmeye uygun olup olmadığını beyan eder.
authorHerhangiİlişkili öğeyi kimin yazdığını beyan eder.
categoryDosya, SınıfBir dizi paketi birlikte gruplandırır.
copyrightHerhangiİlişikili öğenin telif hakkı bilgilerini belgeler.
despecatedHerhangiİlişkili öğenin kullanımdan kaldırıldığını veya gecekteki bir sürümde kaldırılabileceğini söyler.
exampleHerhangiBelirtilen örnek bir dosyanın kodunu veya isteğe bağlı olarak yanlızca bir bölümünü gösterir.
filesourceDosyaÇıktıda kullanım için geçerli dosyanın kaynağını içerir.
globalDeğişkenGenel bir değişkenin phpDocumentor’unu veya kullanımını bildirir.
ignoreHerhangiphpDocumentor’a, ilişkili öğenin belgelere dahil edilip edilmeyeceğini söyler.
internalHerhangiİlişkili öğelerin bu uygulamaya veya kütüphaneye dahil olduğunu ve varsayılan olarak gizlendiğini belirtir.
licenseDosya, Sınıfİlişkili eleman için hangi lisansın uygulanabilir olduğunu belirtir.
linkHerhangiİlişkili öğe ile bir web sitesinin sayfası arasındaki ilişkiyi gösterir.
methodSınıfBir sınıfa hangi ‘magic’ yöntemlerinin çağrılabilir olduğunu bilmesini sağlar.
packageDosya, Sınıfİlişkili öğeyi mantıksal bir gruplama veya alt bölüme ayırır.
paramMetod (Yöntem), FonksiyonBir işlev veya yöntemin tek bir argümanını belgeler.
propertySınıfBir sınıfa, hangi ‘magic’ özelliklerinin mevcut olduğunu bilmesini sağlar.
property-readSınıfSalt okunur olan hangi ‘magic’ özelliklerinin mevcut olduğunu bilmek için bir sınıf verir.
property-writeSınıfBir sınıfa, yalnızca yazma olan, hangi ‘magic’ özelliklerinin olduğunu bilmesini sağlar.
returnMetod (Yöntem), Fonksiyonİşlevlerin veya yöntemlerin dönüş değerini belgeler.
seeHerhangiİlişkili öğeden bir web sitesine veya başka öğelere yapılan bir referansı gösterir.
sinceHerhangiİlişkili öğenin hangi sürümde kullanılabilir olduğunu gösterir.
sourceHerhangi (Dosya hariç)İlişkili öğenin kaynak kodunu gösterir.
subpackageDosya, Sınıfİlişkili öğeyi mantıksal bir gruplama veya alt bölüme ayırır.
throwsMetod (Yöntem), Fonksiyonİlişkili öğenin belirli bir istisna türü atıp atmayacağını belirtir.
todoHerhangiHerhangi bir geliştirme faaliyetinin hala ilgili eleman üzerinde yürütülüp yürütülmeyeceğini belirtir.
usesHerhangiTek bir ilişkili elemana referans (ve form) gösterir.
varProperties
versionHerhangiYapısal elementlerin güncel versionunu gösterir.

PHP ‘deki tüm dökümasyon satırı etiketleri yukarıdaki tablodadır. Çok karmaşık gelebilir ama çok kolaydır.  Unutmayın dökümasyon satırı içine yazılırken etiketlerin başına @ işareti getirilmek zorunludur.

Hadi Dökümasyon Satırı Oluşturalım!

Yukarıdaki örneğimizde bir fonksiyon oluşturduk ve return değerimize string verdik. Parametremizede string değer verdik ve dökümasyon satırını oluşturduk. Ben sadece iki tane etiket kullandım. Siz bunu arttırabilirsiniz. İhtiyaçlarınız doğrultusunda koymanızı öneririz. Evet bu dersimizinde burada sonuna geldik. Herhangi bir sorunuz olursa yorumlarda sorabilirsiniz.

Sitemizdeki tüm PHP dersleri için buraya tıklayabilirsiniz.

[Toplam:0    Ortalama:0/5]

Sizin Tepkiniz Nedir?

süper süper
1
süper
bilgilendirici bilgilendirici
1
bilgilendirici
beğenmedim beğenmedim
0
beğenmedim
beğendim beğendim
0
beğendim
Düşündürücü Düşündürücü
0
Düşündürücü
Anıl Mısırlıoğlu
Yazılım Mühendisi

0 Yorum

E-posta hesabınız yayımlanmayacak. Gerekli alanlar * ile işaretlenmişlerdir

Bir format seçin
Kişisel Test
Kişiliğe dair bir şey ortaya çıkarmayı amaçlayan sorular dizisi
Basit Test
Bilgiyi kontrol etmek isteyen doğru ve yanlış cevaplı sorular dizisi
Anket
Karar vermek veya görüş belirlemek için oylama yapmak
Serbest Yazı
Yazılarınıza Görseller Bağlantılar Ekleyebilirsiniz
Liste
Klasik İnternet Listeleri
Geri Sayım Listesi
Klasik İnternet Geri Sayım Listeleri
Açık Liste
Kendi öğenizi gönderin ve en iyi sunum için oy verin
Oylanabilir Liste
En iyi liste öğesine karar vermek için yukarı veya aşağı basın
Fotoyla Anlatım
Kendi resimlerinizi yükleyin ve birşeyler anlatın
Video
Youtube, Vimeo veya Vine Kodları
Ses
Soundcloud veya Mixcloud İçerikleri
Görsel
Fotoğraf veya GIF
GIF
GIF Formatı