Açıklamalara ve Kodun Okunabilirliğine Giriş

Açıklamalar kodu açıklamak ve daha okunabilir hâle getirmek için kullanılır. Python yorumlayıcısı tarafından yok sayılır ve programın yürütülmesini etkilemez.

Bu derste açıklamaları nasıl kullanacağınızı ve temiz, okunabilir kod yazmayı öğreneceksiniz.

Tek satırlı yorumlar

Tek satırlı yorumlar bir # işaretiyle başlar. Bir satırdaki # işaretinden sonraki her şey Python tarafından yok sayılır. Örneğin:

# This is a single-line comment
print("Hello, World!")

Çok satırlı yorumlar

Çok satırlı yorumlar üç tırnak kullanılarak yazılabilir (''' veya """). Örneğin:

"""
This is a multi-line comment.
It spans multiple lines.
"""
print("Hello, World!")

Yorumlar neden kullanılır?

Yorumlar şunlara yardımcı olur:

• Karmaşık kodu açıklamaya.
• Kodu başkaları ve gelecekteki kendiniz için daha anlaşılır hâle getirmeye.
• Hata ayıklamaya ve sorun gidermeye.

Unutmayın, yorumlar makine için değil, insanlar içindir!

İyi Açıklama Yazma Uygulamaları

İyi açıklamalar yazmak için bazı ipuçları:

• Açıklamaları kısa ve anlamlı tutun.
• x = x + 1 için # Increment x by 1 gibi açıkça anlaşılan açıklamalardan kaçının.
• Kodun belirli bir şekilde yazılma nedenini açıklamak için açıklamaları kullanın.

Kod okunabilirliğini iyileştirme

Okunabilir kodun bakımı ve hata ayıklaması daha kolaydır. İşte bazı ipuçları:

• Anlamlı değişken ve işlev adları kullanın.
• Kod satırlarını kısa tutun.
• Yorumları kullanarak kodu bölümlere ayırın.

Kodu yorum satırına alma

Hata ayıklama amacıyla kodu geçici olarak devre dışı bırakmak için yorumları kullanabilirsiniz. Örneğin:

# print("This line is commented out and won’t run.")
print("This line will run.")

Örnek: Bir işlevi belgeleme

İşlevleri belgelemek ve amaçlarını açıklamak için yorumları kullanabilirsiniz:

def greet(name):
    # This function greets the user by their name.
    print("Hello,", name)

greet("Alice")

Ne Öğrendik?

Bu derste şunları öğrendiniz:

• Python'da tek satırlı ve çok satırlı yorumlar yazmayı.
• Kodun okunabilirliği ve sürdürülebilirliği açısından yorumların önemini.
• Yorum yazmak ve kodun okunabilirliğini artırmak için en iyi uygulamaları.

Harika iş çıkardınız! Şimdi sonraki konuya geçelim.