Python Dersleri 4 – Yorum ve Açıklama Satırı

0 622

Python derslerimize Yorum ve açıklama satırı konusundan devam ediyoruz. Önemsiz gibi görünen ancak doğru kullanıldığında gerçekten çok faydalı olan yorum ve açıklama satırı konusunu ayrıntılı olarak bu derste sizlere aktardık.

Sitemizdeki 4. Python dersini okumaktasınız. Tüm Python Derslerinin listesine buradan ulaşabilirsiniz.

[lwptoc]

Programcılıkta başkalarının yazdıkları kodları okumak ve anlamak çok zordur. Eskiden yazdığımız kodlar bile başkası tarafından yazılmış kodlar gibi anlaşılmaz halde olabilir. Bazen bir programı sıfırdan yazmak başkalarının kodunu okuyup düzeltmekten kolay olabilir. Bunun nedeni, program içindeki kodların ne işe yaradığını anlamanın zorluğudur. Programı yazan kişi kendi düşünüşüne göre bir yol izlemiş ve programı geliştirirken karşılaştığı sorunları çözmek için kimi yerlerde enteresan çözümler üretmiş olabilir. Ancak kodlara dışarıdan bakan birisi için o programın mantık düzenini ve içindeki kodların tam olarak ne yaptığını anlamak bir hayli zor olacaktır. Böyle durumlarda, kodları okuyan programcının en büyük yardımcısı, programı geliştiren kişinin kodlar arasına eklediği notlar olacaktır. Tabii tüm bunların olması için programcının kodların arasına yorum ve açıklama eklemesi şartı vardır.

Yorum ve Açıklama Satırı

Yorum ve Açıklama Satırı
Yorum ve Açıklama Satırı

Python’da yazdığımız kodları başkalarının da anlayabilmesini sağlamak hatta gelecekte kendi yazdığımız kodlara bakınca niye nasıl yazdığımızı anlayabilmemiz için, programımızın  yorumlarla desteklenmesi tavsiye edilir. Programın sorunsuz çalışması için kodlarımıza yorum veya açıklama eklemek zorunda değiliz. Ama programı yorumlarla desteklemek en azından nezaket gereğidir.

Ayrıca işin başka bir boyutu daha var. Sizin yazdığınız kodları nasıl başkaları okurken zorlanıyorsa, kendi yazdığınız kodları okurken siz bile zorlanabilirsiniz. Özellikle uzun süredir ilgilenmediğiniz eski programlarınızı gözden geçirirken böyle bir sorunla karşılaşabilirsiniz. Programın içindeki bir kod parçası, programın ilk yazılışının üzerinden 5-6 ay geçtikten sonra size artık hiçbir şey ifade etmiyor olabilir. Kodlara bakıp, ‘Acaba burada ne yapmaya çalışmışım?’ diye düşündüğünüz zamanlar da olacaktır. İşte bu tür sıkıntıları ortadan kaldırmak veya en aza indirmek için kodlarımızın arasına açıklayıcı notlar ekleyeceğiz.

Python’da yorumlar  “ #  “ işareti ile gösterilir.

[python]#asal sayı bulma fonksiyonu
#10001 . ci asal sayi : 104743

def asalSayiBul(n): #n sayisina kadar olan asal sayıları bulur
k=0
asalSayilar = [True for i in range(n+1)] # istenilen n sayısı büyüklüğünde her elemanı true olan bir dizi oluşturuyoruz
# örnek n = 10 için [True,True,True,True,True,True,True,True,True,True] gibi

p=2 #en küçük asal sayı 2 den başlıyoruz
while(p*p <=n): # p sayısının karesi n den küçük olduğu sürece devam edecek

if(asalSayilar[p]==True): # Eğer sayının karşılığı dizi içinde true ise asal olup olmadığını kontrol ediyoruz

for i in range(p*2,n+1,p):
asalSayilar[i]= False #eğer sayı asal değilse sayıyı ve sayının katlarını dizi içindeki yerlerini false yapıyoruz bu sayede tekrar aynı sayıları kontrol etmeyeceğiz

p+=1

for p in range(2,n):
if asalSayilar[p]:
k+=1
if (k==10001):
print(k,". ci asal sayi : ", p)

asalSayiBul(1000000)

[/python]

Burada dikkat edeceğimiz nokta her yorum satırının başına # işaretini koymayı unutmamaktır. Yazdığımız yorumlar Python’a hiç bir şey ifade etmez. Python bu yorumları tamamen görmezden gelecektir. Bu yorumlar bilgisayardan ziyade kodları okuyan kişi için bir anlam taşır. Elbette yazdığınız yorumların ne kadar faydalı olacağı, yazdığınız yorumların kalitesine bağlıdır. Dediğimiz gibi, yerli yerinde kullanılmış yorumlar bir programın okunaklılığını artırır, ama her tarafı yorumlarla kaplı bir programı okumak da bazen hiç yorum girilmemiş bir programı okumaktan daha zor olabilir! Dolayısıyla Python’da kodlarımıza yorum eklerken önemli olan şey, kaş yapmaya çalışırken göz çıkarmamaktır. Yani yorumlarımızı, bir kodun okunaklılığını artırmaya çalışırken daha da bozmayacak şekilde yerleştirmeye dikkat etmeliyiz.

Yorum İşaretinin Farklı Kullanımları

Yukarıda yorum (#) işaretini kullanarak, yazdığımız Python kodlarını nasıl açıklayacağımızı öğrendik. Python’da yorum işaretleri çoğunlukla bu amaç için kullanılır. Yani kodları açıklamak, bu kodları hem kendimiz hem de kodları okuyan başkaları için daha anlaşılır hale getirmek için… Ama Python’da # işareti asıl amacının dışında bazı başka amaçlara da hizmet edebilir.

Etkisizleştirme Amaçlı

Programımıza eklemek istemediğimiz bir kod varsa ancak silmek te istemiyorsak etkinsizleştirebiliriz. Bu sayede kodlar orada durur ancak çalıştırılmazlar. İngilizcede kodun bu şekilde yorum içine alma işlemine comment out deniyor. Python yorum içinde bir kod bile yer alsa o kodları çalıştırmayacaktır. Çünkü Python # işareti ile başlayan satırların içeriğini görmez (#!/usr/bin/env python3 ve # -*- coding: utf-8 -*- satırları hariç).

Peki neden böyle bir şeye ihityaç duyabilirsiniz. Direk kodu silmek daha iyi olmaz mıydı? Elbette olabilir ancak kodlarınızın hata denetlemelerinde tümünün değilde belli kısımların çalışmasını isteyebilirsiniz. Sadece çalışmasını istediğini bölümün haricindeki kodları yorum satırı olarak işaretleyebilirsiniz. Veya programınızın ileriki sürümlerinde olması üşündüğünüz ancak şu an eklemeyeceğiniz özellikleri bu şekilde sağlayabilirsiniz.

Yorum içine alarak iptal ettiğiniz bu kodları programa ekleme vakti geldiğinde yapacağınız tek şey, kodların başındaki # işaretlerini kaldırmak olacaktır. Hatta bazı metin düzenleyiciler bu işlemi tek bir tuşa basarak da gerçekleştirme yeteneğine sahiptir. Örneğin IDLE ile çalışıyorsanız, yorum içine almak istediğiniz kodları fare ile seçtikten sonra Alt+3 tuşlarına basarak ilgili kodları yorum içine alabilirsiniz. Bu kodları yorumdan kurtarmak için ise ilgili alanı seçtikten sonra Alt+4 tuşlarına basmanız yeterli olacaktır (yorumdan kurtarma işlemine İngilizcede uncomment diyorlar).

Süsleme Amaçlı

Bütün bunların dışında, isterseniz yorum işaretini kodlarınızı süslemek için dahi kullanabilirsiniz:

[python]
#######################################################
#~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~#

# Asal Sayı Bulucu Robotu v.1 #

# Yazan: Halil İbrahim K. #

# Lisans: GPL v2 #

#~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~#
#######################################################
[/python]

Yani kısaca, Python’un görmesini, çalıştırmasını istemediğimiz her şeyi yorum içine alabiliriz. Unutmamamız gereken tek şey, yorumların yazdığımız programların önemli bir parçası olduğu ve bunları mantıklı, makul bir şekilde kullanmamız gerektiğidir.

Programlama konusunda kendinizi geliştirmek ve denemek için buradaki 100 algoritma sorusuna göz atabilirsiniz.

Bu dersler hazırlanırken başta Fırat ÖZGÜL tarafından yazılan Python 3 için Türkçe Kılavuz kitabından ve MEB Bilgisayar Bilimi Kur 1 kitabından yararlanılmıştır.

Cevap bırakın

E-posta hesabınız yayımlanmayacak.

Bu web sitesi deneyiminizi geliştirmek için çerezleri kullanır. Bununla iyi olduğunuzu varsayacağız, ancak isterseniz vazgeçebilirsiniz. Kabul etmek Mesajları Oku