Içindekiler
kodportali.com, PHP 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!
1
2
3
4
5
6
7
8
/*
* Burada $a de $b değişkenine değer atadık.
*/
$a = 1; // Burada $a değişkenine 1 değerini atadık.
$b = 3; # Burada $b değişkenine 2 değerini atadık.
$c = $a + $b; /* Burada $a ve $b değişkeni topladık. */
echo $c; // Burada ise ekrana yazdırdık.
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
|Etiket||Element||Açıklama|
|api||Metod (Yöntem)||Elemanların üçüncü taraflarca tüketilmeye uygun olup olmadığını beyan eder.|
|author||Herhangi||İlişkili öğeyi kimin yazdığını beyan eder.|
|category||Dosya, Sınıf||Bir dizi paketi birlikte gruplandırır.|
|copyright||Herhangi||İlişikili öğenin telif hakkı bilgilerini belgeler.|
|despecated||Herhangi||İlişkili öğenin kullanımdan kaldırıldığını veya gecekteki bir sürümde kaldırılabileceğini söyler.|
|example||Herhangi||Belirtilen örnek bir dosyanın kodunu veya isteğe bağlı olarak yanlızca bir bölümünü gösterir.|
|filesource||Dosya||Çıktıda kullanım için geçerli dosyanın kaynağını içerir.|
|global||Değişken||Genel bir değişkenin phpDocumentor’unu veya kullanımını bildirir.|
|ignore||Herhangi||phpDocumentor’a, ilişkili öğenin belgelere dahil edilip edilmeyeceğini söyler.|
|internal||Herhangi||İlişkili öğelerin bu uygulamaya veya kütüphaneye dahil olduğunu ve varsayılan olarak gizlendiğini belirtir.|
|license||Dosya, Sınıf||İlişkili eleman için hangi lisansın uygulanabilir olduğunu belirtir.|
|link||Herhangi||İlişkili öğe ile bir web sitesinin sayfası arasındaki ilişkiyi gösterir.|
|method||Sınıf||Bir sınıfa hangi ‘magic’ yöntemlerinin çağrılabilir olduğunu bilmesini sağlar.|
|package||Dosya, Sınıf||İlişkili öğeyi mantıksal bir gruplama veya alt bölüme ayırır.|
|param||Metod (Yöntem), Fonksiyon||Bir işlev veya yöntemin tek bir argümanını belgeler.|
|property||Sınıf||Bir sınıfa, hangi ‘magic’ özelliklerinin mevcut olduğunu bilmesini sağlar.|
|property-read||Sınıf||Salt okunur olan hangi ‘magic’ özelliklerinin mevcut olduğunu bilmek için bir sınıf verir.|
|property-write||Sınıf||Bir sınıfa, yalnızca yazma olan, hangi ‘magic’ özelliklerinin olduğunu bilmesini sağlar.|
|return||Metod (Yöntem), Fonksiyon||İşlevlerin veya yöntemlerin dönüş değerini belgeler.|
|see||Herhangi||İlişkili öğeden bir web sitesine veya başka öğelere yapılan bir referansı gösterir.|
|since||Herhangi||İlişkili öğenin hangi sürümde kullanılabilir olduğunu gösterir.|
|source||Herhangi (Dosya hariç)||İlişkili öğenin kaynak kodunu gösterir.|
|subpackage||Dosya, Sınıf||İlişkili öğeyi mantıksal bir gruplama veya alt bölüme ayırır.|
|throws||Metod (Yöntem), Fonksiyon||İlişkili öğenin belirli bir istisna türü atıp atmayacağını belirtir.|
|todo||Herhangi||Herhangi bir geliştirme faaliyetinin hala ilgili eleman üzerinde yürütülüp yürütülmeyeceğini belirtir.|
|uses||Herhangi||Tek bir ilişkili elemana referans (ve form) gösterir.|
|var||Properties||–|
|version||Herhangi||Yapı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!
1
2
3
4
5
6
7
/**
* @param string $text
* @return string
*/
function sendText(string $text) : string{
return 'kodportali.com > ' . $text;
}
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.