Bir program yazarken yorumlar çok önemlidir. Bir programın içinde neler olup bittiğini açıklar, böylece kaynak koduna bakan bir kişi bunu anlamakta zorlanmaz. Bir süre sonra yazdığınız koda tekrar baktığınızda yazdığınız programın önemli detaylarını unutabilirsiniz. Bu kavramları yorum şeklinde açıklamak için zaman ayırmak her zaman verimli olur.
Tek Satırlı Yorumlar
Python’da, bir yorum yazmaya başlamak için hash (#) sembolünü kullanırız. Yeni satır karakterine kadar uzanır.
Yorumlar bir programın daha iyi anlaşılması için programcılara ipucudur. Python yorumlayıcı yorumunu yok sayar.
Çok satırlı yorumlar
Birden fazla satırı uzatan yorumlarımız varsa, bunu yapmanın bir yolu, her satırın başlangıcında hash(#) kullanmaktır.
Örneğin:
1 2 3 4 5 | #Bu bir yorumdur #Bu da bir yorumdur #ve dahi bu da bir yorumdur. |
Bunu yapmanın bir başka yolu, ''' yada """şeklinde üçlü tırnak kullanmaktır.
Bu üçlü alıntılar genellikle çok satırlı dizeler için kullanılır. Ama onlar da çok satırlı yorum olarak kullanılabilir. Onlar docstrings olmadıkça, ekstra kod oluşturmazlar.
1 2 3 4 5 | """Bu çok satırlı yorum yapmanın en iyi yoludur""" |
Python Docstring
Python belgeleme dizeleri (veya belge dizgileri), Python modülleri, işlevleri, sınıfları ve yöntemleri ile belgelerin ilişkilendirilmesi için uygun bir yol sağlar.
Belirli bir kod segmentini belgelemek için kullanılan bir yorum gibi kullanılan kaynak kodda belirtilir. Geleneksel kaynak kodu yorumlarından farklı olarak, docstring işlevinin ne yaptığını açıklamalıdır.
1 2 3 4 5 | def double(num): """Sayının karesini hesaplar""" return 2*num |
Docstring, fonksiyonun __doc__ özniteliği olarak kullanılabilir. Yukarıdaki programı çalıştırdığınızda aşağıdaki kodu kabukta yazın.
1 2 3 4 | >>> print(double.__doc__) Sayının karesini hesaplar |
1 Yorum