PHP Yorum - Açıklama


Orta ve üst düzey projelerde kodlama yaparken çalışmamızın bazı yerlerinde unutmamamız gereken notlar almamız gerekebilir

Her yazılım çalışmasında yazdığımız kodlar için unutmak istemediğimiz detaylar için yada bizden sonra ilgili kodlarda düzenleme yapacak olan yazılımcılar için kodların arasına notlar bırakmamız gerebilir.

PHP, her dilde olduğu gibi kodların arasına tek satırlı ve çok satırlı notlar almayı destekler. Bu alanlara yazılan açıklamaları atlayarak geride kalan kodlarımızı yorumlayarak çalıştırır.



PHP Tek Satır Açıklama Oluşturma

C ve C++ dilindeki stili kullanarak açıklama satırı ekleyelim.

<?php
    // alt satırda isminizi belirtebilirsiniz
    $my_name = 'Yavuz';
?>
<?php
    $my_name = 'Yavuz'; // bu satırda isminizi belirtebilirsiniz
?>

Yukarıda 2 şekilde açıklama satırı ekleme örneğini gördünüz. Gördüğünüz gibi açıklama satırı için bir satırı kullanabildiğiniz gibi, biten bir satırın sonuna da ekleyebilirsiniz. Ekleyeceğiniz açıklamanın başına 2 kez splash işareti koymanız yeterlidir.

Açıklama satırı eklerken kullanabileceğimiz diğer karakter # (diez) karakteri.

<?php
    # alt satırda isminizi belirtebilirsiniz
    $my_name = 'Yavuz';
?>
<?php
    $my_name = 'Yavuz'; # bu satırda isminizi belirtebilirsiniz
?>


PHP Çok Satırlı Açıklama Oluşturma

Kodlarımızın arasına alacağımız notlar tek satıra sığmayacağız zaman birden fazla satır kullanmak istediğimiz durumlarda aşağıdaki örneği kullanabilirsiniz.

<?php
    /*
    Aşağıdaki kodlar üzerinde değişiklik yapmamanızı öneririm.
    Olması gereken değerler;
    mysql sunucusu : 'localhost'
    mysql kullanıcısı : 'root'
    mysql kullanıcı parolası : 'p@ssw0rd'
    mysql veritabanı ismi : 'my_database'
    */
    $config_mysql_host = 'localhost';
    $config_mysql_user = 'root';
    $config_mysql_password = 'p@ssw0rd';
    $config_mysql_database = 'my_database';
?>