Apakah Kode Python Anda Dapat Dibaca?

Saat saya mulai belajar kode Python, saya memperhatikan detail bagaimana kode saya ditulis. Bukan hanya fungsinya, tetapi memastikan kode saya mengikuti praktik terbaik dan dapat dengan mudah ditafsirkan oleh orang lain. Ini adalah kebiasaan penting untuk dimasukkan sehingga jika aplikasi web dibuat atau bagian dari basis kode ditulis di masa mendatang, insinyur perangkat lunak lain dapat dengan mudah melihat apa yang dilakukan kode dan pekerjaan dapat direvisi. Saya merujuk ke Panduan Gaya PEP 8 untuk kode Python untuk mendapatkan gambaran yang lebih jelas tentang seperti apa praktik terbaik dalam pengkodean Python.

Di Python, spasi umumnya lebih disukai daripada tab. Jika Anda memilih untuk melakukannya, Anda dapat menggunakan kode — tetapi tab dan spasi tidak boleh dicampur! Pentingnya konsistensi akan menjadi tema yang berulang di blog ini. Bagi manusia, lebih mudah bagi kita untuk membaca konten dan memahaminya jika konsisten. Identifikasi harus terdiri dari empat spasi. Pada contoh di bawah ini, cetak diindentasi 4 spasi dari awal baris pertama.

Dalam Python, satu baris harus dibatasi hingga 75 karakter. Jika kode Anda melebihi batas 75 karakter, Anda dapat menggunakan indentasi gantung untuk memindahkan kode luapan Anda ke baris berikutnya dan memastikannya masih dapat dibaca. Untuk menyerahkan indentasi, prioritasnya adalah menyejajarkan kode yang melimpah dengan pasangannya di baris sebelumnya sehingga lebih mudah dibaca. Oleh karena itu, indentasi gantung tidak perlu menjorok empat spasi. Di bawah ini adalah contoh kode luapan yang menggunakan indentasi gantung.

Spasi ekstra antara tanda kurung dan tanda baca juga harus dihindari. Terkadang saya harus mengingatkan diri sendiri bahwa saya sedang menulis kode, bukan makalah. Di bawah ini adalah contoh ruang putih yang mengerikan. Secara umum, membaca ulang kode Anda adalah praktik yang baik untuk memastikan ruang tambahan tidak terselip ke dalam kode Anda secara tidak sengaja.

Terakhir, penting agar kode Python berisi komentar dan komentar ini mudah dibaca. Komentar Python harus ditulis dalam kalimat lengkap dan harus dimulai dengan huruf kapital, kecuali kata pertama adalah variabel yang huruf kecil. Jika ada beberapa kalimat dalam komentar, harus ada dua spasi setelah tanda titik. (Latihan makalah saya akhirnya berguna di sini!). Komentar sangat penting jika ada bagian kode yang tujuannya tidak jelas.

Ada kasus di mana Panduan Gaya PEP 8 tidak memiliki preferensi. Dalam kasus ini, Anda dapat memilih gaya kode yang diinginkan, tetapi Anda harus berusaha untuk selalu konsisten. Ingat, konsistensi adalah kuncinya!

Sumber:

Lima Tips untuk Meningkatkan Keterbacaan Kode Python Anda. Rekayasa untuk Ilmu Data

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