Python’da Yorum Yazma Rehberi

Çalışan bir kod yazmak işin sadece yarısıdır — anlaşılır bir kod yazmak sizi harika bir geliştirici yapar. İşte burada yorumlar devreye girer. Python’da yorumlar, kodunuzun mantığını açıklamanıza, işlevselliği belgelemeye ve uzun vadeli okunabilirliği artırmaya yardımcı olur — özellikle de üretim sunucularında betikler dağıtıldığında veya bulut üzerinde barındırılan arka uç uygulamalarını sürdürürken.

Python’u yeni öğreniyor, bir barındırma ortamında sunucu tarafı otomasyonu yönetiyor veya bir ekip projesi oluşturuyorsanız, bu rehber etkili yorumlar yazma konusunda bilmeniz gereken her şeyi size gösterecektir.

Python’da Yorumlar Nedir?

Yorumlar, Python yorumlayıcısının göz ardı ettiği kodunuzdaki satırlardır. İnsanların kodun ne yaptığını, neden belirli bir şekilde yazıldığını veya gelecekte ne yapılması gerektiğini anlamalarına yardımcı olmak için varlardır.

 1. Tek Satırlı Yorumlar

Python’da tek satırlı yorumlar # işareti ile başlar.

# This is a single-line comment
print("Hello, world!") # This prints a message

Aşağıdakileri açıklamak için tek satırlı yorumlar kullanın:

  • Bir kod bloğunun ne yaptığını

  • Neden belirli bir değer veya yöntem kullanıldığını

  • Gelecek güncellemeler için yapılacak notları

2. Çok Satırlı Yorumlar

Python’un bazı diğer dillerdeki gibi yerel bir çok satırlı yorum sözdizimi yoktur. Yaygın bir çözüm, birden fazla tek satırlı yorum kullanmaktır:

# This section handles user input
# and validates email address format
user_email = input("Enter your email: ")

Uzun açıklamaları tek bir yorum satırında yerleştirmekten kaçının — netlik için bunları bölün.

3. Satır İçi Yorumlar

Satır içi yorumlar, bir kod ifadesi ile aynı satıra yerleştirilir:

x = 42 # The answer to everything

✅ Yapın belirli satırları netleştirmek için satır içi yorumları az kullanın.
❌ Yapmayın aşikar olanı belirtin:

x = 5 # Assign 5 to x ← not helpful

 4. Docstring’ler (Belgeleme Dize)

Teknik olarak yorum olmasa da, docstring’ler fonksiyonları, sınıfları ve modülleri belgelemek için kullanılan üçlü tırnak işareti (”’ veya “””) ile çevrili çok satırlı dizelerdir.

def greet(name):
"""Return a personalized greeting."""
return f"Hello, {name}!"

Bir fonksiyonun docstring’ini almak için:

help(greet)

Docstring’leri aşağıdakiler için kullanın:

  • Fonksiyon açıklamaları

  • Parametre açıklamaları

  • Dönüş değerleri

Python Yorumları Yazarken En İyi Uygulamalar

  • ✅ Onları özlü ve ilgili tutun

  • ✅ Neden üzerine odaklanın, neye değil

  • ✅ Tutarlı dil ve stil kullanın

  • ✅ Kod değişirse yorumları güncelleyin

  • ✅ Gereksiz veya eski yorumlardan kaçının

 Kötü Yorum Örneği:

x = 10 # Set x to 10

✅ İyi Yorum Örneği:

x = 10 # Initial buffer size before scaling

Hata Ayıklama ve Testte Yorumlar

Test sırasında kodu geçici olarak devre dışı bırakmak için yorumları kullanabilirsiniz:

# print("Debug:", user_data)

Son dağıtımdan önce bunları kaldırmayı veya gözden geçirmeyi unutmayın.