İçeriğe geç
Başlangıç · Sonraki hedefe 100 XP
Son hareketler
Henüz bir öğrenme hareketi yok. İlk derse başlayın.

Programlama Temelleri

PHP yorumları: Kararın gerekçesini belgeleme

İyi yorum kodun ne yaptığını tekrar etmez; neden bu yolun seçildiğini, hangi koşulun korunacağını ve değişikliğin sınırlarını açıklar.

Bu derste neler var?

SİBERSALDİRİ.COM · KONU ODAKLI DERS

Bu derste kazanacaklarınız

  • Karar ile Gerekçe arasındaki ilişkiyi açıklamak.
  • “Kodun aynısını söyleyen yorum neden zayıftır?” sorusuna gerekçeli yanıt vermek.
  • Örneği değiştirip beklenen ve gözlenen davranışı karşılaştırmak.

Çalışma mantığı ve güven sınırı

Tek satırlı yorum kısa gerekçe, blok açıklaması ise işlevin sözleşmesi için uygundur. Bir fonksiyonun beklediği girdiyi, hata davranışını ve yan etkisini belgeleyin. Kod değişirken yorum da gözden geçirilmelidir; eski davranışı anlatan açıklama bakım sırasında yanlış karar ürettirebilir. Yorum satırı gizli veri saklama alanı değildir.

PHP yorumları: Kararın gerekçesini belgeleme akışı: Karar → Gerekçe → Bakım
Karar → Gerekçe → Bakım. Şema ilişkiyi gösterir; bütün uygulamanın yerine geçmez.

Açıklamalı örnek

Aşağıdaki parça kavramı görünür kılar. Komut veya kod içeren örnekleri üretim sisteminde değil, size ait ayrı deneme ortamında değerlendirin. Mimari şema ve politika örnekleri çalıştırılabilir program değildir.

<?php
// Tek istekte işlenen kayıt sayısı belleği sınırlamak için kısıtlıdır.
$limit = 50;
echo $limit, PHP_EOL;

Beklenen sonuç ve yorumu

Yalnızca 50 yazılır; yorum çalıştırılmaz ve çıktıya eklenmez.

Karşılaştırmalı durumlar

DurumBeklenen yaklaşımNeden?
Neden üst sınır varGerekçeyi yazBakım kararını destekler
Kod değişmiş yorum eskiBirlikte güncelleYanlış varsayım yaratır
Yorumda parola varKaldır ve sırrı döndürGeçmişte kalmış olabilir

Uygulama görevi

Üst sınırın neden seçildiğini bir cümleyle yazın. Değer değiştiğinde yorumun hâlâ doğru olup olmadığını inceleyin.

  1. İşlemden önce beklenen sonucu ve kabul koşulunu yazın.
  2. Tek bir değişkeni değiştirin; gözlemi ve kullandığınız ortamı kaydedin.
  3. Sonucu yukarıdaki karşılaştırma tablosuyla değerlendirin. Uymayan durumda hangi varsayımın yanlış olabileceğini açıklayın.

Sık yapılan hata ve düzeltme yönü

Parola veya erişim anahtarını yorumda bile tutmayın; depo geçmişine girebilir.

Kendinizi sınayın

Kodun aynısını söyleyen yorum neden zayıftır?

Açıklamalı yanıt: Kod zaten işlemi gösterir; yorumun ek değeri karar gerekçesini ve korunacak varsayımı açıklamasıdır.

İlgili derslerle ilerleyin

Teknik başvuru

Bu dersin anlatımı ve örnekleri akademi için yeniden hazırlanmıştır. Aşağıdaki bağlantı, kullanılan teknoloji veya güvenlik yaklaşımının ayrıntılarını doğrulamak için teknik başvurudur.

Bir adım daha ilerlediniz.

Dersi bitirdiyseniz tamamlandı olarak işaretleyin. İlerlemeniz bu cihazda saklanır.

Akademi menüsü

Akademide ara

En az 2 karakter yazın.