Tasarım Kodlama

PHP Yorumları Nasıl Yapılır (Neden Bilmeniz Gerekir)

Web siteleri geliştirmek için PHP öğrenirken, zamanınızın çoğunu, dinamik sayfalar yapmak için harcarsınız. Yada bir veritabanındaki verileri değiştirmek ve dilin diğer yararlı fonksiyonalarını nasıl kullanacağınızı öğremenle geçirirsiniz.

Ancak, yorum satırlarından haberiniz olmayabilir. Yorumlanan kod, kodunuzun geri kalanı gibi “çalışmaz”, ancak dosyalarınızla çalışmayı çok daha kolay hale getirir.

PHP ile yorumlar, kodunuzu ilk kez okuyan bir geliştirici kodun net olamayan kısımlarını anlayabilmesi için yardımcı olacaktır. Ayrıca can sıkıcı hataların ayıklanması için de faydalıdırlar ve programlamayı öğrenirken erkenden oluşturmak için iyi bir alışkanlıktır.

PHP Yorumları Nasıl Yapılır (Neden Bilmeniz Gerekir)
PHP Yorumları Nasıl Yapılır (Neden Bilmeniz Gerekir)

Bu yazıda, kodunuzu geliştirmek için PHP yorumlarını nasıl kullanacağınızı ve bunları nasıl yazacağınız öğreneceksiniz.

PHP’de yorumlar, bir program çalıştırıldığında yürütülmeyen kod bölümleridir. Son kullanıcılar PHP yorumlarını görmezler – yalnızca bir dosyadaki PHP kodunu görüntülerken görünürler. PHP yorumları genellikle programcıların PHP kodunu anlamasına ve yorumlamasına yardımcı olmak içindir.

Bir PHP yorumu, diğer programcılara belirli bir kod bölümünün amacını açıklayabilir. Bu şekilde, bir geliştirici bir PHP dosyasını ilk kez görüntülediğinde, baktığı kodu daha kolay anlayabilir.

Benzer şekilde, yorumlar programcılara neden belirli bir şekilde kod yazdıklarını hatırlatmaya yardımcı olur. Bir PHP dosyası oluşturabilir ve daha sonra aylarca veya yıllarca geri dönmeyebilirsiniz. Sonunda dosyayı yeniden açtığınızda, eski kodunuza hızla alışabilmeniz için kapsamlı yorumlara sahip olmak isteyeceksiniz. Veya işinizde kaldığınız yer gibi kendinize kısa notlar bırakmak için yorumları kullanabilirsiniz.

Ek olarak, hata ayıklama amacıyla belirli kod bölümlerini geçici olarak devre dışı bırakmak için PHP yorumları kullanılabilir. PHP dosyanızda bir hata keşfettiğinizi varsayalım – kodun bir bölümünü yorum satırını içine alabilir. Programı yeniden çalıştırabilir ve hatanın devam edip etmediğini görebilirsiniz. Bu, hata ayıklarken kod satırlarını silmekten çok daha kolaydır (ve daha güvenlidir).

PHP Yorum Sözdizimi

PHP’nin iki yerleşik yorum yöntemi vardır: tek satırlı yorumlar ve çok satırlı yorumlar. Bunlar biraz farklı yazılır.

Tek satırlı PHP Yorumları

Tek satırlık PHP yorumları, bir kod bloğundan önceki kısa notlar için veya tek bir kod satırını açıklamak için kullanışlıdır. Tek satırlık bir yorum bırakmak için, iki eğik çizgi (//) ve ardından yorum metninizi yazın. //‘nin sağındaki tüm metinler yok sayılır. Tek satırlık bir yorum yapmak için // yerine bir kare sembolü (#) de kullanabilirsiniz.

Çok Satırlı PHP Yorumları

PHP ayrıca, daha büyük bir kod bölümünü yorumlamak veya daha açıklayıcı bir yorum bırakmak istemeniz durumunda, birden çok satıra yayılan yorumlara da izin verir. Çok satırlı yorumunuza /* yazarak başlayın ve */ yazarak bitirin. Örneğin:

PHP yorumları en iyi uygulamadır

İncelemek için, bir işlevin veya bir kod satırının amacını açıklığa kavuşturmak için kısa notlar için tek satırlı yorumları kullanın ve bir kod bloğunun daha ayrıntılı bir açıklaması veya bir geliştiriciye verilen bir not gibi daha uzun notlar için çok satırlı yorumları kullanın. daha sonra silebilirler.

PHP’de (ve diğer kodlama dillerinde), yorumlar genellikle yeterince kullanılmaz. İlk başta, dosyalarınıza daha fazla yığın ekleyen gereksiz bir adım gibi görünebilirler. Ancak, ekipler halinde çalışmaya ve uzun vadeli karmaşık projeler üstlenmeye başladığınızda, zaten yorum yazma alışkanlığınız olmalı – bu, size ve diğerlerine bir şeyleri çözmeye çalışırken çok zaman kazandıracak.

Yorum Satırı ile Değişken Veri Türünü Bildirme (PHPDoc)

PHPDoc, PHP kodunu belgelemenin ve açıklama eklemenin standart bir yoludur. /** karakterleriyle öneklenen blok yorumlarının iyi bilinen bir biçimidir ve işlevlere, sınıflara, özelliklere ve ayrıca yerel değişkenlere açıklama eklemek için kullanılır. PHPDoc ile düzenleyici için belgeler, ek tür bilgileri ve diğer bilgileri sağlamak mümkündür.

Yazının tamamı için buradaki bağlantıya tıklayın.

1 yorum