Python Yorum Satırları (Açıklama Satırları)
Yorum satırları, kodun içinde yer alan ancak yorum olarak işlenen ve programın çalışma sırasında dikkate alınmayan metinlerdir. Bu yazıda, Python programlama dilinde yorum satırları oluşturmanın nasıl yapıldığına, neden önemli olduklarına ve en iyi uygulamalarına dair bilgileri öğreneceksiniz.
Yorum Satırları
Programlamada yorum satırları, kodları daha anlaşılabilir kılmak ve programı daha kullanışlı hale getirmek için yaygın bir şekilde kullanılmaktadır.
Yorum satırları, herhangi bir programlama dilini öğrenmeye başlayanların çoğu zaman göz ardı ettiği özelliklerdir. Kod yazarken, o an ne yaptığımızı genellikle çok iyi biliriz. Ancak aynı kodu haftalar, aylar ya da yıllar sonra tekrar incelediğimizde ne düşündüğümüzü veya niçin belirli bir yöntemi seçtiğimizi hatırlamakta zorlanabiliriz.
İşte tam da bu sebepler için yorum satırları biçilmiş kaftandır. Zira yorumlar, bir kod bloğunun ne iş yaptığını, neden bu şekilde yazıldığını veya belirli bir kısmın neden bu şekilde düzenlendiğini açıklamak için kullanılır. Aynı zamanda, diğer geliştiricilere kodun işleyişi ve amacı hakkında fikir verir. Özellikle büyük projelerde veya takım halinde çalışırken yorumlar, ekip üyelerinin birbirlerinin kodlarına adapte olmalarına yardımcı olur.
Python Tekli Yorum Satırı: #
Python’da tek satırdan oluşan bir yorum satırı oluşturmak için diyez (#) işaretini kullanırız. Bu işaretten sonra gelen her şey Python yorumlayıcısı tarafından dikkate alınmaz. Yani bunun bir yorum olduğunu bilir.
Kodunuza # eklediğiniz anda, sağında kalan her şey yorum olarak algılanır. Dolayısıyla programınızın dilediğiniz yerine kullanabilirsiniz. Bakınız:
|
1 2 3 4 5 6 7 |
# Kullanıcının yaşını hesaplayan fonksiyon def yas_hesapla(dogum_yili): return 2023 - dogum_yili # 2023 mevcut yıl olarak kabul edilmiştir. #Bir başka örnek def kare_al(sayi): return sayi * sayi # Girilen sayının karesini hesaplar. |
Yukarıdaki örneklerde, yorum satırları kodun işlevini daha açık bir şekilde ifade etmek için kullanılmıştır. İlk örnekte, fonksiyonun ne iş yaptığını açıklayan bir yorum satırı vardır. Ayrıca not olarak yapılan işlemin nedeni açıklanmıştır. İkinci örnekte ise fonksiyonun yaptığı işlemin özetini satırın sonuna ekleyerek açıklamıştır. Bu tür yorumlar, kodun daha okunabilir ve anlaşılır olmasını sağlar.
Yorum satırları sadece kodun işlevini açıklamak için değil, aynı zamanda belirli kod bloklarını geçici olarak devre dışı bırakmak (yani yorum içine almak) için de kullanılır. Bu, genellikle kodun belirli bir bölümünün etkisini görmek veya bir hata ayıklama işlemi yaparken oldukça kullanışlıdır.
|
1 2 3 4 5 |
print("Bu satır çalışır.") # print("Bu satır çalışmaz çünkü yorum satırı içindedir.") print("Bu satır da çalışır.") |
Bu yaklaşım, özellikle yazılım geliştirme sürecinde belirli özellikleri veya fonksiyonları geçici olarak devre dışı bırakmak istediğinizde kullanışlıdır. Ayrıca, bazen kodun belirli bir kısmının neden devre dışı bırakıldığına dair bir açıklama eklemek de iyi bir uygulamadır, böylece ileride bu kodu gözden geçirenler için daha anlaşılır olur.
Python Çoklu Yorum Satırları: “”” “”” veya ”’ ”’
Python’da çoklu yorum satırı oluşturmak için üç tırnak (''' veya """) kullanılır. Ancak teknik olarak bu, gerçek bir “çoklu yorum” oluşturmaz. Daha ziyade, çok satırlı bir string oluşturur. Ancak, bu string atanmadığı veya kullanılmadığı için, pratikte bir yorum gibi işlev görür ve bu nedenle çoklu satır yorumları oluşturmak için yaygın olarak kullanılır. Örneğin:
|
1 2 3 4 5 6 7 |
''' Bu bir çoklu yorum satırıdır. Kod içerisinde bu satırların hiçbiri çalıştırılmaz. Bu özellik, büyük bloklar halinde yorum yapmak için oldukça kullanışlıdır. ''' print("Bu satır çalışır.") |
Çoklu yorum satırları, belli başlı durumlarda yaygın bir şekilde kullanılır. Bu durumları aşağıdaki gibi özetleyebiliriz:
- Dökümantasyon: Çoklu yorum satırları, genellikle fonksiyonlar, sınıflar veya modüller için dökümantasyon oluşturmak amacıyla kullanılır. Bu tür yorumlar genellikle fonksiyon tanımlarının hemen altında yer alır ve fonksiyonun ne yaptığı, parametrelerinin ne olduğu ve döndürdüğü değer hakkında bilgi içerir. Örneğin:
|
1 2 3 4 5 6 7 8 9 10 11 12 |
def toplama(a, b): ''' İki sayının toplamını döndüren fonksiyon. Parametreler: - a: İlk sayı - b: İkinci sayı Çıktı: İki sayının toplamı ''' return a + b |
Bu örnekte, toplama fonksiyonunun hemen altında çoklu yorum satırıyla bir dökümantasyon bloğu ekledik. Böylece, fonksiyonun ne yaptığı, hangi parametreleri aldığı ve ne döndürdüğü hakkında bilgi sağlamış olduk.
- Kod Bloklarını Devre Dışı Bırakma: Çoklu yorum satırları, birden fazla kod satırını hızlı bir şekilde devre dışı bırakmak için de kullanılabilir. Özellikle hata ayıklama sırasında veya kodun belirli bölümlerini geçici olarak kapatmak istediğinizde bu özellik oldukça kullanışlıdır.
|
1 2 3 4 5 6 7 8 |
print("Bu çalışır.") ''' print("Bu çalışmaz.") print("Bu da çalışmaz.") ''' print("Bu yine çalışır.") |
Yukarıdaki örnekte, iki print fonksiyonunu çoklu yorum satırı içerisine alarak geçici olarak devre dışı bıraktık.
- Açıklama ve Notlar: Büyük bir kod bloğunu açıklamak veya belirli bir kısmı üzerinde çalışırken alınan notları eklemek için çoklu yorum satırları kullanılır. Bu, kodun daha sonraki bir tarihte gözden geçirilmesi durumunda yardımcı olabilir.
|
1 2 3 4 5 6 7 8 |
''' TODO: - Veritabanı entegrasyonunu kontrol et. - Hata logları oluştur. - Kullanıcı arayüzünü iyileştir. ''' print("Program başlatılıyor...") |
Bu örnekte, kodun belirli bölümleri üzerinde yapılması planlanan işler için bir “TODO” listesi ekledik. Bu tür notlar, projenin ilerleyen aşamalarında yapılacak işleri hatırlamak için oldukça kullanışlıdır.
Yorum Satırları Nasıl Kullanılmalı?
Yorum satırı olabildiğince kodu daha okunabilir hale getirmek için kullanılmalıdır. Kodlamayı öğrenme aşamasında pekala not tutma amaçlı yorum satırını dilediğiniz şekilde kullanabilirsiniz ama profesyonel bir kullanım adına kodu sade bir şekilde açıklamak en optimum olanıdır.
Zira, çoklu yorum satırları gereğinden fazla kullanıldığında kodun okunabilirliğini azaltabilir. Bu nedenle dengeli ve yerinde kullanmak önemlidir. Aşağıdaki örnekte yorum satırının kötü bir şekilde kullanılması örneklendirilmiştir
|
1 |
print ("Hello, World!") # bu kod satırı Hello, World!döndürür. |
Gereksiz bir açıklama yerine anlaşılır bir şekilde kullanılan yorum satırı aşağıdaki gibi olmalıdır:
|
1 |
d = math.sqrt(l**2 + w**2) # köşegen uzunluğu |
Bir kodun nasıl çalıştığını tam olarak anlamış olsanız bile, bir dikdörtgenin köşegen uzunluğunun hesaplandığı matematiksel formülleri aklınızda tutamayabilirsiniz. Böylesi durumlarda yorum satırı kullanmanız yararınıza olacaktır.
Özetle, Python yorum satırları, kodları daha anlaşılabilir kılmak ve programı daha kullanışlı hale getirmek için kullanılmaktadır.