Yorumlar

BERK'te kod içine açıklama eklemek için yorumlar kullanılır.

Tek Satırlık Yorumlar

Çift slash (//) ile başlar:

// Bu bir yorumdur
değişken x = 10  // Satır sonunda yorum

işlev hesapla() {
    // Fonksiyon içinde yorum
    geri dön 42
}

Çok Satırlı Yorumlar

/* ile başlar, */ ile biter:

/*
   Bu çok satırlı
   bir yorumdur.
   Birden fazla satır içerebilir.
*/

değişken sonuç = /* inline yorum */ 42

Dokümantasyon Yorumları

Üçlü slash (///) fonksiyon ve modül dokümantasyonu için kullanılır:

/// İki sayının toplamını hesaplar.
/// 
/// Parametreler:
/// - a: İlk sayı
/// - b: İkinci sayı
/// 
/// Dönüş: İki sayının toplamı
işlev topla(a: Sayı, b: Sayı) -> Sayı {
    geri dön a + b
}

Best Practices

✅ İyi Yorumlar

// Kullanıcı kimliğini veritabanından çek
değişken kullanıcı = db.getir(id)

// HACK: Geçici çözüm, v0.9'da düzeltilecek
değişken temp_fix = workaround()

// TODO: Performans optimizasyonu gerekli
işlev yavaş_fonksiyon() { ... }

// FIXME: Edge case'lerde hata veriyor
işlev hatalı_fonksiyon() { ... }

❌ Kötü Yorumlar

// x'i 1 artır
x += 1  // Gereksiz, kod zaten açık

// Bu fonksiyon bir şey yapar
işlev bir_şey_yap() { ... }  // Belirsiz

// Değişken tanımla
değişken y = 10  // Anlamsız yorum

Annotation'lar

Özel yorumlar kodun davranışını etkileyebilir:

// @deprecated: Artık kullanılmıyor, yerine yeni_fonksiyon() kullanın
işlev eski_fonksiyon() { ... }

// @performance: Kritik yol, optimizasyon önemli
işlev sık_çağrılan() { ... }

// @unsafe: Manuel bellek yönetimi
işlev düşük_seviye() { ... }