Pythonda Nasıl Yorum Yapılır – Yeni Başlayanlar İçin Hızlı Bir Kılavuz

Yorumlar, Python da dahil olmak üzere herhangi bir programlama dilinin önemli bir parçasıdır. Sizin ve diğer geliştiricilerin kodunuzun mantığını ve işlevselliğini anlamanıza yardımcı olurlar. Python kodunuza yorumlar eklediğinizde, yalnızca kodunuzu açıklamanıza yardımcı olmakla kalmaz, aynı zamanda okunabilirliğini, kalitesini ve sürdürülebilirliğini de geliştirir.

Bu Python eğitiminde, tek satırlık yorum, çok satırlı yorum ve çok satırlı dizelerin nasıl yazılacağını keşfedeceğiz. Python programınızda yorum kullanma, farklı Python yorum türlerini anlama ve her yorum türü için çeşitli kullanım durumlarını ayrıntılı olarak ele alacağız . Bu, iyi yorumların nasıl yazılacağını, satır içi yorumların nasıl ekleneceğini ve kötü yazılmış kod yazmaktan nasıl kaçınılacağını gösteren örnekleri içerecektir.

Hadi başlayalım.

İçindekiler

• Tek Satırlık Yorumlar Nedir?
• Çok Satırlı Yorumlar Nedir?
  • Üçlü Tırnak Kullanma
  • Satır Devamlı Bir Hash Sembolü Kullanma
• Satır İçi Yorumlar Nedir?
• Belge dizileri nedir?
  • İşlev ve Yöntem Belgeleri
  • Sınıf Belgeleri
  • Modül Belgeleri
• Yorum Yazmak İçin En İyi Uygulamalar
  • Açıklık ve Özlülük
  • Açık Yorumlardan Kaçınma
  • Kod Değişiklikleri Olarak Yorumları Güncelleme
• Çözüm

Tek Satırlık Yorumlar Nedir?

Python programlamada , satırın başındaki hash karakteri (#) kullanılarak tek satırlık bir yorum oluşturulur. Aynı satırda hash sembolünü takip eden herhangi bir metin, tek satırlık bir yorum olarak değerlendirilir ve Python yorumlayıcısı bunu yürütmez.

Python kodunda tek satırlık yorumları kullanmanın iki temel amacı vardır:

1. Belirli Python kod segmentinin kısa bir açıklamasını veya tek satırlık özetini sağlayarak, kodun işlevi veya amacı hakkında bilgi sunar.

2. Tek bir kod satırının yürütülmesini geçici olarak devre dışı bırakma; bu, kodu betiğinizden kalıcı olarak kaldırmadan hata ayıklama veya test sırasında yardımcı olur.

Aşağıda, Python kodunu tek bir satırda açıklamak için nasıl yorum yazılacağına bir örnek verilmiştir:

Bu örnekte, her bir tek satırlık yorum, her bir kod satırı için açıklamalar sunarak sizin ve diğer geliştiricilerin kodun amacını anlamasını kolaylaştırır.

Aşağıdaki Python kodu , tek bir kod satırının yürütülmesini önlemek için nasıl yorum yazılacağını gösterir:

Yukarıdaki örnekte, kod çalıştırıldığında çalıştırılmasını önlemek için, hata ayıklama amacıyla amaçlanan dize hazır değerleri içeren konsol print deyimi yorumlanmıştır. Tek satırlık yorum, Python yorumlayıcısının satırı bir kod parçası yerine yorum olarak ele almasını sağlar.

Hataları ayıklarken ve çözerken belirli kod satırlarını yorumlamak faydalı olabilir.

Açık, kısa ve ilgili tek satırlık yorumlar yazma alışkanlığını benimsemek, kodunuzun belirli yönlerini açıklamaya odaklanmanıza yardımcı olacağından iyi bir uygulamadır. İyi yazılmış yorumlar oluşturarak, Python programlarınızın okunabilirliğini ve sürdürülebilirliğini önemli ölçüde artırır, başkalarının kodunuzu anlamasını ve onunla çalışmasını kolaylaştırırsınız.

Çok Satırlı Yorumlar Nedir?

Python çok satırlı yorumları, belirli kod bölümleriyle ilgili daha kapsamlı açıklamalar veya notlar sağlarken faydalıdır. Ayrıca, hata ayıklama veya geliştirme sırasında birden fazla kod satırını her bir satırı ayrı ayrı yorumlamak zorunda kalmadan geçici olarak devre dışı bırakmanız gerektiğinde kullanışlı olurlar.

Python'da çok satırlı yorumlar oluşturmak için iki yöntem vardır :

1. Üçlü Alıntı Kullanma

2. Devamlı bir Hash Sembolü Kullanma

Üçlü Tırnak Kullanma

Python'da çok satırlı yorumlar oluşturmanın bir yolu , üç ardışık tek veya çift tırnaktan oluşan üçlü tırnak kullanmaktır.

Bir metin bloğu üçlü tırnak içine alındığında, Python bunu bir dize olarak yorumlar ve bir değişkene atanmamışsa dikkate almaz.

Bu teknik, kodunuzun okunabilirliğini artırarak Python çok satırlı yorumları veya birkaç satıra yayılan çok satırlı dizeler yazmanıza olanak tanır.

Aşağıdaki kod, Python kodunda çok satırlı bir yorum bloğu için üçlü tırnak kullanımının açıklanmasına yardımcı olur :

'''
This is a multi-line comment
in Python using triple quotes.
'''
print("Hello World!")

Yukarıdaki kod yalnızca "Merhaba Dünya!" üç tırnaklı çok satırlı dize yorumlayıcı tarafından göz ardı edildiğinden.

Satır Devamlı Bir Hash Sembolü Kullanma

Python'da çok satırlı yorumlar oluşturmak için başka bir yaklaşım, okunabilirliği korumak için satır devam karakterleriyle () birlikte her satırın başında karma sembolleri (#) kullanmayı içerir.

Aşağıda, Python'da çok satırlı yorumların nasıl yazılacağına bir örnek verilmiştir:

# This is a multi-line comment in Python
# using hash symbols with line continuation.
# It spans multiple lines, but each line requires a hash symbol.
print("Hello World!")

Yukarıdaki örnekte yalnızca “Merhaba Dünya!” hash sembolü ile başlayan satırlar yorumlayıcı tarafından çok satırlı yorum olarak ele alındığından da çıktı olacaktır.

Satır İçi Yorumlar Nedir?

Python'daki satır içi yorumlar, belirli kod satırları için bağlam veya açıklamalar sağlamanıza olanak tanır. Bu tür yorumlar, bir kare işareti (#) ile ayrılmış olarak kod ifadesiyle aynı satıra yerleştirilir.

Python'da bir satır içi yorum örneği aşağıdadır:

x = 10  # This variable stores the value 10
y = x * 2  # Multiply x by 2 to get the value of y
print(y)  # Output the value of y

Satır içi yorumlar, idareli bir şekilde ve yalnızca belirli bir kod satırını açıklamak gerektiğinde kullanılmalıdır. Kodunuz kapsamlı satır içi yorum gerektiriyorsa, daha açıklayıcı değişken veya işlev adları kullanarak kodun kendisini daha açık ve anlaşılır hale getirmeyi düşünün.

Belge dizileri nedir?

Belge dizileri, kodunuzu etkili bir şekilde belgelemek için değerli bir araç olarak hizmet eder. Hem size hem de diğer geliştiricilere, kodunuzun nasıl çalıştığını ve amaçlanan amacını anlamanıza yardımcı olurlar.

Belge dizilerini Python programlarınıza dahil ederek, kodunuzun okunabilirliğini ve sürdürülebilirliğini büyük ölçüde artıran açık, özlü ve yardımcı açıklamalar oluşturabilirsiniz.

Bu uygulama, geliştiriciler arasında daha iyi işbirliği ve iletişimi teşvik ederek sonuçta oluşturduğunuz yazılımın kalitesini artırır.

Python'da, tümü aynı sözdizimine sahip ancak farklı kullanım durumlarına sahip üç tür belge dizisi vardır:

1. İşlev ve Yöntem Belgeleri

2. Sınıf Belgeleri

3. Sınıf Belgeleri

İşlev ve Yöntem Belgeleri

İşlev ve yöntem dokümanları, bir işlev veya yöntemin amacını, bağımsız değişkenlerini, dönüş değerlerini ve yan etkilerini açıklar.

Aşağıda, işlev ve yöntem belge dizilerinin bir örneği verilmiştir:

def add(a, b):
    """Add two numbers and return the result."""
    return a + b

Bu belge dizisi her zaman işlevin özlü ama bilgilendirici bir açıklamasını sağlamalıdır.

Sınıf Belgeleri

Sınıf belgeleri, Python'da bir sınıfın amacını ve davranışını açıklar.

Aşağıda, Python'da bir sınıfın amacını ve davranışını açıklamak için sınıf belgelerinin kullanımına bir örnek verilmiştir.

class MyClass:
    """A simple class to demonstrate docstrings."""
    
    def __init__(self, x):
        self.x = x

Belge dizisi, sınıfın işlevselliğine, sahip olabileceği tüm önemli özniteliklere veya özelliklere ve programınızdaki diğer sınıflar veya işlevlerle nasıl etkileşime girdiğine dair bir genel bakış sağlamalıdır.

Modül Belgeleri

Modül belge dizileri, Python modüllerinizin veya modül dosyalarınızın başına yerleştirilmelidir ve modülün amacına ve içeriğine kapsamlı bir genel bakış sunar.

İyi yazılmış bir modül dokümantasyonu ekleyerek, geliştiricilerin modülünüzün projenizin genel mimarisine nasıl uyduğunu ve sağladığı belirli işlevleri hızlı bir şekilde belirlemesini sağlarsınız.

Bu uygulama yalnızca kodunuzun okunabilirliğini ve sürdürülebilirliğini artırmakla kalmaz, aynı zamanda aynı proje üzerinde çalışan ekip üyeleri arasında işbirliğini ve anlayışı geliştirir.

Aşağıda, belgeleri Python dosyalarıyla ilişkilendirmek için modül belge dizilerini kullanmanın bir örneği verilmiştir:

"""
geometry.py

This module contains functions to calculate the area of various geometric shapes,
such as rectangles, circles, and triangles. The main functions provided are:

- rectangle_area(width, height)
- circle_area(radius)
- triangle_area(base, height)

Each function takes the respective dimensions as input and returns the calculated area.
"""

def rectangle_area(width, height):
    return width * height

def circle_area(radius):
    import math
    return math.pi * (radius ** 2)

def triangle_area(base, height):
    return 0.5 * base * height

# Rest of the code...

Modülün birincil özellikleri ve içerdiği önemli değişkenler, sınıflar veya işlevler.

Yorum Yazmak İçin En İyi Uygulamalar

Tamam, artık Python'daki farklı yorum türleri ve bunların nasıl kullanılacağı hakkında iyi bir fikriniz var, yüksek çalışma standardını korumak için bazı en iyi uygulamalara bakalım.

Açıklık ve Özlülük

Python'da yorum yazarken, netlik ve özlülük arasında bir denge kurmak çok önemlidir. Yorumların kısa ve bilgilendirici kalmasını sağlarken düşüncelerinizi kolay anlamayı kolaylaştıracak şekilde ifade etmeyi hedefleyin.

Yorumların aşırı uzun ve sürdürülmesi zor hale gelmesini önlemek için gereksiz bilgileri eklemekten kaçının, bu da sonuçta kafa karışıklığına yol açabilir.

İyi hazırlanmış bir yorum, kodunuzla zahmetsizce bütünleşerek okunabilirliği ve sürdürülebilirliği artırmalıdır.

Açık Yorumlardan Kaçınma

Python'da herhangi bir yorum yazarken bariz açıklamalardan kaçınmak önemlidir . Kodun ne yaptığını basitçe yeniden ifade etmek veya çoğaltmak yerine, kodun kendisinden kolayca anlaşılamayacak içgörüler sunmaya odaklanın.

Bu, tek satırlık yorum yazmak için olduğu kadar çok satırlı yorumlar için de geçerlidir.

Bunu göstermek için, bariz bir yorumla daha faydalı bir alternatifi karşılaştıran aşağıdaki örneği ele alalım:

# Bad comment
x = x + 1  # Increment x by 1

# Good comment
x = x + 1  # Adjust x to account for the new user added

Kod Değişiklikleri Olarak Yorumları Güncelleme

Kod geliştikçe Python yorumlarını güncel tutun. Güncel olmayan yorumlar yanıltıcı olabilir ve kafa karışıklığına neden olabilir. Kodunuzda önemli değişiklikler yaparken okunabilirliği ve anlaşılırlığı korumak için Python yorumlarını uygun şekilde ayarlayın.

Python bilginizi derinleştirmek için aşağıdaki kapsamlı Python videolarımıza göz atın.

Çözüm

Kodunuzu yorumlamak, anlamaya, korumaya yardımcı olmak ve ortak çalışanlar için değerli belgeler olarak hizmet etmek gibi birçok avantaj sunar.

Etkili yorum sağlamak için:

1. Yorumları kısa, alakalı ve bilgilendirici tutun.

2. Tek satırlık yorumlar için bir kare simgesi (#) ve ardından bir boşluk kullanın.

3. Çok satırlı yorumlar yazmak için tırnak işaretleri (“”””””) kullanın

4. Bağlam veya açıklamalar için satır içi kullanın ve yorumları engelleyin.

5. Okunabilirliği korumak için kod geliştikçe yorumları güncelleyin.

6. Programlama becerilerini geliştirmek için düşünceli yorumlar yazma alıştırması yapın.

Tutarlı bir şekilde iyi hazırlanmış yorumları kullanarak, yalnızca kendinize ve başkalarına yardımcı olmakla kalmaz, aynı zamanda programlama uzmanlığınızı da yükseltirsiniz.

Ayrıca, yorum kalitesine dikkat ederek ve değerli içgörüleri yorumlarınıza dahil ederek daha etkili, düzenli ve profesyonel bir kodlayıcı olacak, başkalarıyla işbirliği yapmayı ve kodunuzu uzun vadede korumayı kolaylaştıracaksınız.