Python Açıklama (Yorum) satırı Nasıl Eklenir?

Programlama, bilgisayar kullanarak bir sorunu çözmek için attığınız adımları tek tek tanımlamak için düşünme şeklinizi yansıtır. Kodunuzu yorumlamak, düşünce sürecinizi açıklamaya yardımcı olur ve sizin ve başkalarının kodunuzun amacını daha sonra anlamanıza yardımcı olur. Bu, hataları daha kolay bulmanıza, düzeltmenize, kodu daha sonra iyileştirmenize ve diğer uygulamalarda da yeniden kullanmanıza olanak tanır.

Yorum yapmak, küçük, orta veya oldukça büyük olsun, her tür proje için önemlidir. İş akışınızın önemli bir parçasıdır ve geliştiriciler için iyi bir uygulama olarak görülür. Yorumlar olmadan, işler çok hızlı bir şekilde kafa karıştırıcı olabilir. Bu yazıda, Python dilinde çeşitli yöntemlerle modül oluşturma kavramını değerlendireceğiz.

İyi ve Kötü Yorumlar

Yorumlar ne kadar önemliyse, yine de kötü yorumlar yazmak mümkün. Her zaman kısa olmalı, doğrudan konuya girmeli ve bilgilendirici değer katmalıdırlar.

Örneğin, bu oldukça işe yaramaz bir yorumdur:

Sonraki örnek, bunun yerine daha yararlı bir yorum gösterir ve değişkenlere bariz adlar vererek devam eder:

Yorum Türleri

Python’da bir yorum, # ile başlar ve fiziksel satırın sonuna kadar uzanır. Yine de, bir dize değeri içindeki bir karma karakter yorum olarak görülmez. Kesin olmak gerekirse, bir yorum üç şekilde yazılabilir – tamamen kendi satırında, bir kod ifadesinin yanında ve çok satırlı bir yorum bloğu olarak.

Aşağıdaki bölümlerde her bir yorum türünü açıklayacağım.

Tek Satır Yorumlar

Böyle bir yorum, bir kare karakterle (#) başlar ve ardından daha fazla açıklama içeren metin gelir.

Çok Satırlı Yorumlar

Yukarıda belirtildiği gibi, tüm bir yorum bloğu Python tarafından da anlaşılır. Bu yorumlar, kodunuzu okuyan diğer kişiler için satır içi belgeler işlevi görür ve genellikle işleri daha ayrıntılı olarak açıklar.

Teknik olarak Python, çok satırlı yorumlar için açık bir desteğe sahip değildir, bu nedenle aşağıdaki seçenekler bazıları tarafından bir geçici çözüm olarak kabul edilir, ancak yine de çok satırlı yorumlar amacıyla çalışır.

Sürüm 1, tek satırlı yorumları aşağıdaki gibi birleştirir:

Sürüm 2, sürüm 1’den daha basittir. Orijinal olarak dokümantasyon oluşturmak için kullanılmak üzere tasarlanmıştır (aşağıda bununla ilgili daha fazla bilgi bulabilirsiniz), ancak çok satırlı yorumlar için de kullanılabilir.

Python kodunuza uygun yorumları yazmak o kadar karmaşık değil ve sadece dayanıklılığın gücüne ihtiyacınız var. Kodunuzu daha sonraki bir tarihte tekrar ziyaret ettiğinizde kendiniz de dahil olmak üzere kodunuzu anlamaya çalışan hepimize yardımcı olur. Size burada verdiğimiz tavsiyenin, kodunuzda daha iyi yorumlar ve belgeler oluşturmanızı kolaylaştıracağını umuyoruz.