Destek Online
MirrorLooking Glass
GenixNodeGenixNode
Müşteri Paneli
Ana içeriğe geç

Ruby'de Yorum Satırlarını Kullanma Rehberi

Yorum satırları (comments), Ruby programlarında çalıştırılmayan ancak kodun amacını açıklayan satırlardır. Bu rehber, yorumları nasıl yazacağınızı, hangi durumlarda kullanılacağını ve en iyi pratikleri öğretir.

🧠 Bu Rehberde Ne Öğreneceksiniz?​

  • Ruby'de tek satır ve çok satır (block) yorum yazımı
  • Inline yorumların nasıl ve ne zaman kullanılacağı
  • Yorum satırlarıyla hata ayıklama (debugging)
  • Kod geliştirirken bölümleri geçici olarak devre dışı bırakma

🔹 1. Ruby'de Yorum Yazma Temelleri​

Ruby'de yorum satırları # karakteri ile başlar ve satır sonuna kadar devam eder.

# Bu bir Ruby yorumudur.
puts "Merhaba Dünya!"

💡 Okunabilirliği artırmak için # işaretinden sonra bir boşluk bırakmak önerilir.

Yorumlar, Ruby yorumlayıcısı tarafından tamamen yok sayılır; sadece geliştiriciler içindir.

Basit bir programda açıklama eklemek için:

# Kullanıcıdan adını alır
gets.chomp

# Ekrana merhaba mesajı yazdırır
puts "Merhaba!"

🔹 2. Kod Açıklama Örneği​

Aşağıdaki örnek, bir diziyi HTML listeye dönüştürür. Yorumlar, her adımın ne yaptığını açıklar.

sharks = ['hammerhead', 'great white', 'dogfish']

# Her elemanı HTML listesi haline getirir
listitems = sharks.map { |shark| " <li>#&#123;shark&#125;</li>\n" }

# Tamamlanmış <ul> etiketiyle yazdırır
print "<ul>\n#{listitems.join}</ul>"

💬 Yorumlar, kodun amacını açıklar ama çalışmasını etkilemez.

🔹 3. Girintili (Indented) Yorumlar​

Yorumlar, açıklama yaptıkları kodla aynı girintide (indent) olmalıdır:

class Eightball
  # Cevap seçeneklerini oluşturur
  def initialize
    @choices = ["Evet", "Hayır", "Belki"]
  end

  # Rastgele bir cevap döndürür
  def shake
    @choices.sample
  end
end

💡 Girinti hizalaması, özellikle sınıf ve metodlarda okunabilirliği artırır.

🔹 4. Blok (Çok Satırlı) Yorumlar​

Uzun açıklamalar için her satıra # koyabilirsiniz:

# Bu blok yorum, birkaç satır boyunca
# kodun genel amacını açıklar.
# Özellikle karmaşık fonksiyonlarda tercih edilir.

Alternatif olarak =begin ve =end kullanılabilir:

=begin
Bu bir çok satırlı yorumdur.
Her satır başına `#` koymaya gerek yoktur.
=end

⚠️ Bu yöntem sadece satır başında çalışır, girintili satırlarda hata verir.

🔹 5. Inline (Satır İçi) Yorumlar​

Bir satırın sonunda kısa açıklama yapabilirsiniz:

pi = 3.14  # Pi sabitinin yaklaşık değeri

💡 Inline yorumlar kısa ve öz olmalıdır.

Birden fazla kişiyle çalışırken karmaşık işlemleri açıklamak için yararlıdır:

a = Complex(4, 3) # 4 + 3i karmaşık sayısını oluşturur

🔹 6. Kod Satırlarını Geçici Olarak Devre Dışı Bırakma​

Test veya hata ayıklama sırasında bazı satırları çalıştırmak istemiyorsanız, yorum satırı haline getirebilirsiniz:

# puts "Bu satır çalışmayacak"
puts "Bu satır çalışacak"

Bir oyun örneğinde:

if cevap == 'y'
  # play  # Tekrar oynamayı devre dışı bırak
else
  exit
end

💬 Bu teknik, test yaparken hatalı satırları geçici olarak etkisiz hale getirmek için kullanılır.

💡 En İyi Yorum Pratikleri​

  • Kodun ne yaptığını değil, neden yaptığını açıklayın.
  • Gereksiz veya tekrarlayan yorumlardan kaçının.
  • Yorumları kodla birlikte güncel tutun; eski yorumlar kafa karıştırır.
  • Uzun açıklamalar için blok yorum, kısa notlar için inline yorum kullanın.

💬 Sıkça Sorulan Sorular (SSS)​

1️⃣ Ruby yorumları programı yavaşlatır mı? Hayır. Ruby yorumlayıcısı yorum satırlarını tamamen yok sayar.

2️⃣ Inline yorumlar ne kadar uzun olabilir? Kısa ve tek satır olmalıdır; aksi halde okunabilirliği düşürür.

3️⃣ Kodun bir kısmını test dışı bırakmak için başka yöntem var mı? Yorum satırı dışında, koşullu ifadeleri (if false) kullanabilirsiniz.

4️⃣ =begin / =end neden önerilmez? Girintiyle çalışmadığı için modern Ruby geliştiricileri tarafından nadiren tercih edilir.

5️⃣ Yorumları kim okumalıdır? Hem ekip arkadaşlarınız hem de gelecekteki siz. Kodun nedenini hatırlamak için harikadır.

🎯 Sonuç​

Ruby’de yorumlar, kodunuzu daha okunabilir ve işbirliğine uygun hale getirir. Kodu belgelemek, test sırasında bölümleri geçici olarak devre dışı bırakmak ve ekibinizin anlamasını kolaylaştırmak için yorumları etkili şekilde kullanın.

💡 Deneyin: GenixNode üzerinde bir Ruby projesi açın ve farklı yorum türlerini pratik edin.