Python’da Bir Kod Bloğunu Nasıl Yoruma Alırsınız

Python ile çalışırken yorumlar en kullanışlı araçlardan biridir. Çalıştırmayı etkilemeden kod bloklarının arkasındaki mantığı, kararları ve amaçları açıklarlar. Yorumlar, kodu daha okunabilir ve bakımı kolay hale getirir, ekip içi işbirliğini de kolaylaştırır.

Bu eğiticide, Python’da birden fazla satırı yoruma almak için iki etkili yöntemi inceleyerek kodunuzun iyi belgelenmiş ve kolay anlaşılır olmasını sağlayacağız.

Python’da Blok Yorumlar Neden Önemlidir?

Yorumlar, Python öğrenme yolculuğunuzda genellikle karşılaştığınız ilk kavramlardan biridir. Belirli bir kod parçasının arkasındaki niyete ilişkin yararlı bağlam sağlar. Bir betiğin neden belirli bir şekilde davrandığına açıklık ve bağlam getirirler. Betiklerinizde yorum kullanmanız için çeşitli önemli nedenler vardır. İşte dördü:

• Belgelendirme: Yorumlar, fonksiyonların, sınıfların veya kod bloklarının amacını açıklayan bir belgelendirme biçimi olarak hizmet eder. Bu, mantığı hemen anlaşılamayabilecek karmaşık algoritmalar için özellikle kullanışlıdır.
• Okunabilirlik: İyi yorumlanmış kod okumak ve anlamak daha kolaydır. Bu, siz veya başkaları koda bir süre sonra geri döndüğünde kritik önem taşır.
• Hata ayıklama: Kod bölümlerini geçici olarak yoruma almak, hataları yalıtmak ve tespit etmek için yaygın bir uygulamadır.
• İşbirliği: Ekip ortamında yorumlar, kodu daha paylaşılabilir ve anlaşılır kılar, daha sorunsuz işbirliği ve kod incelemelerini sağlar.

Python’da Tek Satırlı Blok Yorumları Kullanma

Birden fazla satırı yoruma almaya geçmeden önce, tek satırlı yorumların temelinden başlayalım. Python’da tek satırlı bir yorum diyez (#) simgesiyle başlar ve o satırda onu izleyen her şeyi Python yorumlayıcısı yoksayar. Tek satırlı bir yorum oluşturmak için aşağıdaki yönergeleri izleyin:

1. Konum: Satırın başına veya aynı satırdaki koddan sonra # simgesini yerleştirin. Yorumlar, açıkladıkları kodun üstüne, kodla aynı satırda sağa veya bağımsız olarak yerleştirilebilir.
2. İçerik: # simgesinden sonra yorumunuzu yazın. Bu, kod satırının açıklaması, ileride referans için bir not veya kodla ilgili her türlü yararlı bilgi olabilir.

# This is a single-line comment explaining the next line of code
print("Hello, world!")  # This prints a message to the console

Yöntem #1: Birden Fazla Tek Satır # Kullanarak Yoruma Alma

Python’da yoruma almanın en doğrudan yolu, satırda kendisinden sonra gelen her şeyi yoruma alan # simgesini kullanmaktır. Python’da blok yorumlar için özel bir sözdizimi olmasa da, her satırı ayrı ayrı yoruma almak için birden fazla # simgesi kullanabilirsiniz. Tüm yapmanız gereken aşağıdaki adımları uygulamaktır:

1. Kod bloğunu belirleyin: Önce, yoruma almak istediğiniz kod bloğunu belirleyin. Bu bir fonksiyon, bir döngü veya devre dışı bırakmak ya da açıklamak istediğiniz her hangi bir kod bölümü olabilir.
2. Her satırı yoruma alın: Yoruma almak istediğiniz her satırın başına bir # simgesi yerleştirin. Bu, Python yorumlayıcısına çalıştırma sırasında bu satırları yoksaymasını söyler.

Aşağıdaki örneği görebilirsiniz:

# Example of commenting out multiple lines individually 
# print("Hello, world")
# print("What are you up to?")

print("Just floating in space. What was the question?")

Python Blok Yorum Yöntemi #2: Üç Tırnaklı Dize İfadeleriyle Yoruma Alma

Birden fazla satırı yoruma almanın alternatif bir yolu, üç tırnaklı dize ifadelerini (''' ''' veya """ """) kullanmaktır. Resmi blok yorum olmasalar da, bu dize ifadeleri sıklıkla özellikle çok satırlı yorumlar veya docstringler için bu amaçla kullanılır. Üç tırnaklı dizeleri kullanmak için, yoruma almak istediğiniz kod bloğunun öncesine ve sonrasına ''' veya """ yerleştirmeniz yeterlidir:

'''
def example_function(name):
	print("Hello", name)
'''

Üç tırnaklı dize ifadeleri en sık Python fonksiyonlarını belgelemede kullanılır. Örneğin:

# Create hello() function
def hello(name):
	'''
	This function takes as input a name, 
	and returns a salutation to the name in the form of "Hello name"
	'''
	# Print the output 
	print("Hello", name)

hello("John")

Bu üç tırnaklı dize ifadelerine docstring denir — onlar hakkında daha fazlasını docstring eğiticimizde okuyabilirsiniz.