Python Kodunuz Okunabilir mi?

Python'u kodlamayı öğrenmeye başlarken, kodumun nasıl yazıldığına dair ayrıntılara dikkat ediyorum. Yalnızca işlevselliği değil, kodumun en iyi uygulamalara bağlı kalmasını ve başkaları tarafından kolayca yorumlanabilmesini sağlamak. Bu, dahil edilmesi gereken önemli bir alışkanlıktır, böylece gelecekte bir web uygulaması oluşturulursa veya bir kod tabanının bir kısmı yazılırsa, diğer yazılım mühendisleri kodun ne yaptığını kolayca görebilir ve iş revize edilebilir. Python kodlamada en iyi uygulamanın nasıl göründüğüne dair daha net bir resim elde etmek için Python kodu için PEP 8 Stil Kılavuzuna başvurdum.

Python'da boşluklar genellikle sekmelere tercih edilir. Bunu yapmayı seçerseniz, kod kullanabilirsiniz - ancak sekmeler ve boşluklar karıştırılmamalıdır! Tutarlılığın önemi bu blogda yinelenen bir tema olacak. İnsanlar için, tutarlı olması durumunda içeriği okumamız ve anlamamız daha kolaydır. Tanımlama dört boşluktan oluşmalıdır. Aşağıdaki örnekte print ilk satırın başından itibaren 4 boşluk girintilidir.

Python'da bir satır 75 karakterle sınırlandırılmalıdır. Kodunuz 75 karakter sınırını aşacaksa, taşan kodunuzu bir sonraki satıra taşımak ve hala okunabilir olduğundan emin olmak için asılı girinti kullanabilirsiniz. Girintileri teslim etmek için öncelik, taşan kodu bir önceki satırdaki karşılığıyla sıralayarak daha kolay okunmasını sağlamaktır. Bu nedenle, asılı girintilerin dört boşluk girintilenmesi gerekmez. Aşağıda, asılı girinti kullanan taşan kod örneği verilmiştir.

Parantez ve noktalama işaretleri arasındaki fazladan boşluktan da kaçınılmalıdır. Bazen kendime dönem ödevi değil kod yazdığımı hatırlatmam gerekiyor. Aşağıda korkunç bir beyaz boşluk örneği var. Genel olarak, kodunuza yanlışlıkla fazladan bir boşluk girmediğinden emin olmak için kodunuzu yeniden okumak iyi bir uygulamadır.

Son olarak, Python kodunun yorum içermesi ve bu yorumların kolay okunabilir olması önemlidir. Python yorumları tam cümleler halinde yazılmalı ve ilk kelime küçük harfli bir değişken olmadığı sürece büyük harfle başlamalıdır. Bir yorumda birden fazla cümle varsa, noktadan sonra iki boşluk bırakılmalıdır. (Dönem ödevi uygulamam sonunda burada işe yarıyor!). Amacı net olmayan bir kod bölümü varsa yorumlar özellikle önemlidir.

PEP 8 Stil Rehberinin bir tercihinin olmadığı durumlar vardır. Bu durumlarda, kodunuzu nasıl biçimlendirmek istediğinizi seçebilirsiniz, ancak her zaman tutarlı olmaya çalışmalısınız. Unutmayın, tutarlılık anahtardır!

kaynaklar:

Python Kodunuzun Okunabilirliğini Artırmak için Beş İpucu. Veri Bilimi için Mühendislik

https://engineeringfordatascience.com/posts/top_tips_for_improving_python_code_without_refactoring/