10 Prisip Kodingan yang Baik
Saat membuat software ada kalanya kita membuatnya dalam kerja tim atau ada supervisor yang mengawasi kualitas kode yang kita tulis, oleh karena itu seenggaknya kita membuat prinsip pengodean yang baik.
Prinsip pengodean yang baik membuat kode sumber software kita mudah dipahami oleh orang lain. Dengan ini software kita menjadi mudah dimaintain oleh kita sendiri maupun orang lain. Berikut 10 prinsip pengodean yang baik:
1. Ikuti Spesifikasi Kode
Software kita terbuat dari banyak kumpulan aliran teks kode sumber yang diproses kompiler maupun interpreter menjadi bahasa mesin. Karena banyak teks alangkah baiknya kita mengikuti aturan standar industri seperti python "PEP 8", atau dengan menyepakati sendiri pada internal tim atau perusahaan agar kode konsisten atau mudah dipahami.
2. Dokumentasi
Kadang saat menulis software kita memakai trik atau cara-cara tertentu yang terlihat pintar atau membingungkan, inilah gunanya dokumentasi, kita memperjelas dengan kalimat-kalimat yang bagus untuk manusia dibaca. Contohnya saat kita membuat fungsi REGEX. Standarnya dokumentasi adalah berisi mengapa ("Why") fungsi atau bagian ini ada.
3. Kesehatan
Kode yang kita tulis diharapkan dapat menangani bermacam-macam input, bisasakan mengunakan try-catch dan tampilkan exception yang muncul untuk mudah dipahami.
4. Ikuti prinsip SOLID
“Single Responsibility”, “Open/Closed”, “Liskov Substitution”, “Interface Segregation”, and “Dependency Inversion” - kelima prinsip ini (disingkat SOLID) adalah landasan penulisan kode yang dapat diskalakan dan mudah dipelihara.
5. Mudahkan diTes
Kemampuan software untuk dites sangat penting. Kode yang baik seharusnya mudah dites. Kode dipisah-pisah agar tidak rumit, sekarang ini sudah banyak alat tes otomatis yang bisa digunakan.
6. Abstraksi
Abstraksi mengharuskan kita untuk mengekstrak logika inti dan menyembunyikan kompleksitasnya, sehingga membuat kode lebih fleksibel dan generik. Kode yang baik harus memiliki tingkat abstraksi yang moderat, tidak terlalu rumit maupun mengabaikan kemampuan pengembangan dan pemeliharaan jangka panjang.
7. Gunakan Design Patterns, tetapi Jangan Over Design
Design pattern adalah pola desain yang sudah banyak ditemui pada berbagai software karena bisa saja fungsi yang kita buat memecahkan masalah yang sama pada software lain. Namun, setiap pola memiliki skenario penerapannya masing-masing. Penggunaan pola desain yang berlebihan atau salah dapat membuat kode Anda lebih kompleks dan sulit dipahami.
8. Kurangi ketergantungan Global
Sekarang ini banyak pustaka-pustaka disediakan oleh paket menajemen seperti npm, pip, dll. Kita bisa saja tergiur untuk menggunakannya berlebihan dan menyebarkan ketergantungan global yang berlebihan.
9. Refactoring berkesinambungan
Kode yang baik mudah dipelihara dan diperluas. Refactoring berkelanjutan mengurangi hutang teknis dengan mengidentifikasi dan memperbaiki masalah sedini mungkin.
10. Keamanan adalah Prioritas
Hacker itu ada, jadi berhati-hati lah. Ikuti saran standar keamanan.
![[image]](https://res.cloudinary.com/djuyt5yew/image/upload/v1781146254/0051-10-good-coding-principles_ra46ia.png)
Kalasan Tech. Lab.