Bu eğitimde, örnekler yardımıyla Python'da yorum oluşturmayı öğreneceğiz.
Video: Python'da Yorumlar
Yorumlar, programcıların programın amacını ve işlevselliğini daha iyi anlamasına yardımcı olan açıklamalardır.
Python yorumlayıcısı tarafından tamamen yok sayılırlar.
Yorumları Kullanmanın Avantajları
Programlarda yorum kullanmak, kodumuzu daha anlaşılır hale getirir. Programı daha okunaklı hale getirir ve bu da belirli kod bloklarının neden yazıldığını hatırlamamıza yardımcı olur.
Bunun dışında yorumlar, diğer kod bloklarını test ederken bazı kodları yok saymak için de kullanılabilir. Bu, bazı satırların yürütülmesini önlemenin veya program için hızlı bir sözde kod yazmanın basit bir yolunu sunar.
Python'da Tek Satırlı Yorumlar
Python'da, #tek satırlık bir yorum yazmak için hash sembolünü kullanırız.
Örnek 1: Tek Satırlı Yorumlar Yazma
# printing a string print('Hello world')
Çıktı
Selam Dünya
İşte yorum:
# printing a string
Bu satır Python yorumlayıcısı tarafından dikkate alınmaz.
Sonrasında gelen her şey #göz ardı edilir. Yani yukarıdaki programı tek satırda da şöyle yazabiliriz:
print('Hello world') #printing a string
Bu programın çıktısı Örnek 1'deki ile aynı olacaktır . Tercüman sonraki tüm metni yok sayar #.
Python'da Çok Satırlı Yorumlar
Python, çok satırlı yorumlar yazmak için ayrı bir yol sunmaz. Ancak, bu sorunu aşmanın başka yolları da var.
Biz kullanabilirsiniz #birden hatlarda yorumun her satırın başında.
Örnek 2: Birden çok # kullanma
# it is a # multiline # comment
Burada her satır tek bir yorum olarak değerlendirilir ve hepsi yok sayılır.
Çok Satırlı Yorumlar için Dize Değişmezleri
Python'da çok satırlı yorumlar yazmanın benzersiz bir yolu olmasa da, Python yorumlayıcısının bir değişkene atanmamış dize değişmezlerini göz ardı ettiğini biliyoruz.
Yani, tek satırlık bir yorum bile yazabiliriz:
#this is a comment 'this is an unassigned string as a comment '
Burada programın ikinci satırının bir dizge olduğunu ancak herhangi bir değişkene veya işleve atanmadığını görebiliriz. Dolayısıyla, yorumlayıcı dizeyi yok sayar.
Benzer şekilde, çok satırlı yorumlar yazmak için çok satırlı dizeleri (üçlü tırnak) kullanabiliriz.
Tırnak karakteri 'veya olabilir ".
Örnek 3: Çok Satırlı Yorumlar yazmak için Dize Değişmezlerini Kullanma
''' I am a multiline comment! ''' print("Hello World")
Burada, çok satırlı dizge herhangi bir değişkene atanmaz, bu nedenle yorumlayıcı tarafından yok sayılır. Teknik olarak çok satırlı bir yorum olmasa da, tek olarak kullanılabilir.
Python dokümanları
Geleneksel olarak, işlev, yöntem veya sınıf tanımından hemen sonra görünen üçlü tırnaklar belge dizeleridir (dokümantasyon dizeleri).
Dokümanlar nesnelerle ilişkilidir ve bu __doc__nitelik kullanılarak erişilebilir .
Daha fazla bilgi edinmek için Python docstrings adresini ziyaret edin.
Daha İyi Yorumlar Nasıl Yazılır?
- Bir işlevin ne yaptığını açıklamak için yorumları kullanın, işlevin nasıl yaptığına ilişkin belirli ayrıntıları değil.
- Mümkün olduğunca fazla sayıda gereksiz yorumu kaldırmaya çalışın. Daha iyi işlev / değişken adı seçimi kullanarak kendini açıklayabilecek bir kod yazmayı deneyin.
- Yorumları olabildiğince kısa ve öz yapmaya çalışın.
