Clean Code ialah gambaran bagaimana kode yang dibuat oleh tim developer ditulis secara rapi, terstruktur dan mudah dipahami. Inti dari clean code ini adalah tidak hanya berfokus pada fungsionalitas, tetapi juga pada keterbacaan dan kemudahan pemeliharaan. Kode yang rapi mudah diikuti oleh developer lain, memudahkan proses debugging, sekaligus memfasilitasi kolaborasi dengan Tim.
Clean code dapat dicapai melalui beberapa praktik seperti penamaan variabel, dan function yang jelas, struktur algoritma yang logis, menghindari duplikasi pada code serta dokumentasi yang memadai.
Clean code juga mengikuti prinsip – prinsip seperti DRY (Don’t Repeat Yourself), dan KISS (Keep it Simple, Stupid), Dimana prinsip ini menekankan pada keserderhanaan dan efisiensi.
Manfaat Clean Code
-
Mudah Dipelihara (Maintanability)
Harus mudah untuk dipelihara dan dikelola dengan artian setiap perubahan, pembaruan, dan perbaikan bisa dilakukan dengan cepat dan efisien. Ini akan secara langsung mempengaruhi baik dari segi waktu maupun biaya terkait pemeliharaan software
-
Mudah identifikasi bug
Kejelasan struktur dan kemudahan dalam algoritma akan meminimalkan waktu yang dibutuhkan untuk menemukan sekaligus memperbaiki bug.
-
Mudah dipahami
Lebih mudah dipahami developer lain sangat penting dalam proyek, ini akan mempercepat onboarding dan kolaborasi.
-
Efisiensi dalam indexing mesin pencari
Dengan Clean code dan kode yang terstruktur ini akan mudah bagi search engine untuk melakukan indeksing. Proses ini penting untuk website, dimana loading time dan struktur kode menjadi salah satu factor yang mempengaruhi waktu pencarian.
-
Memudahkan testing
Clean code akan memudahkan pengujian otomatis, hal ini akan meningkatkan kualitas kode dan mengurangi jumlah bug, hingga pada akhirnya meningkatkan nilai dari software secara penuh.
-
Hemat biaya
Ini akan berkontribusi pada penghematan iaya dalam jangka panjang, clean code mengurangi waktu dan sumber daya yang digunakan untuk mengelola dan memperbaharui software.
Bagaimana menulis clean code
-
Keep it Simple
Buat kode sesederhana mungkin, dengan kode yang sederhana dapat menghasilkan kode yang berkualitas lebih tinggi, memecahkan masalah lebih cepat, bekerja lebih baik kelompok pengembang, dan memiliki basis kode yang lebih fleksibel.
-
Understand your Code
Dengan memahami kode yang dibuat ini akan menjadi kunci awal untuk memecahkan masing – masing masalah, bahkan menurut para ahli memahami kode yang dibuat adalah cara terbaik untuk memecahkan masalah.
-
Comments Are Your New Best Friends
Komentar ini akan memudahkan anggota lain untuk memahami gagasan tentang kode tersebut, maka dari itu menambahkan komentar adalah sebuah tip yang mencakup sebuah Bahasa pemrograman dalam menjelaskan secara singkat apa ide yang terkandung dalam kode yang dibuat.
-
Don’t Repeat Yourselft (DRY)
Ini dirumuskan oleh Any Hunt dan Dave Thomas dalam The Pragmatic Programmer. Adalah penggunaan fungsi, kelas, dan instance untuk menghindari pengetikan ulang kode yang telah ditulis satu kali, prinsip dasar ini memungkinkan pengembang untuk tidak menduplikasi kode untuk menghasilkan kode yang bersih.
-
Indent Your Code
Indentasi pada kode mirip dengan pengaturan yang diperlukan di supermarket atau tempat lain di dunia nyata, kode yang di indentasi akan lebih muda dibaca dan lebih mudah menemukan apa yang dicari.
-
Naming Convention
Ini sangat penting karena dalam sebuah kode penamaan harus relevan, oleh karena itu, beri nama elemen berdasarkan apa adanya dan biasakan untuk mempertahankan konvensi di seluruh kode yang dibuat.
Follow Code Conventions
Setiap teknologi pasti memiliki konvensinya masing – masing, misalnya pada penamaan sebuah class untuk java yang harus pascalCase dan harus dromedaryCase untuk variabelnya, konvensi yang diciptakan ini dengan tunuan untuk memudahkan orang lain dalam memahami kode yang ditulis
Sayangnya, ada beberapa konvensi pada teknologi tertentu yang membeaskan pemrograman atau timnya untuk memnentukan sendiri. Khususnya pada Node.js dan Typescript, misalnya pada penggunaan titik koma (;) yang tidak wajib dituliskan. Maka dari itu ada aturan baru yang bernama linter.
Linter adalah alat untuk membuat aturan – aturan sehingga menjadi konvensi dan untuk mendeteksi error atau wanrning secara dini pada program sebelum di kompilasi. Dan mungkin ada bayaran yang harus dibayar dengan menggunakan linter ini yaitu waktu yang digunakan untuk kompilasi cenderung lebih lama.
