Kenapa Harus Clean Code?
Halo teman teman semua, kembali lagi ke pembahasan kita tentang dunia Software Engineering. Pada kesempatan kali ini kita akan membahas tentang Clean Code. Jadi apa itu Clean Code? Apa yang harus dibersihkan? Tenaaang, kita akan dapat jawaban dari pertanyaan tersebut setelah membaca artikel ini. Let’s Check it Out!!
Apa itu Clean Code
Clean code adalah code yang memenuhi standar berikut :
- Mudah dibaca
- Mudah dipahami
- Mudah di maintenance
Menurut Clément Mihailescu (ex-Google Software Engineer) dari kanal Youtube nya, Clean code adalah :
Clean code is that it’s code leaves you with a feeling of Satisfaction, like “Aaaah, this is Good code”
Jadi bisa kita simpulkan bahwa Clean Code adalah bagaimana kita membuat sebuah code menjadi mudah dibaca, dipahami dan digunakan kembali oleh orang lain baik pada saat ini maupun di kemudian hari nanti.
Lalu, bagaimana cara membuat code kita “Clean”?
Kita tahu, kita harus membuat code yang kita buat mudah dipahami oleh orang lain. Lalu bagaimana cara nya? Apakah kita harus membuat comment untuk setiap line? Atau membuat dokumentasi super panjang untuk menjelaskan code kita?
Buku di atas adalah salah satu sumber belajar paling direkomendasikan untuk implementasi Clean Code. Sebenarnya banyak hal yang harus kita lakukan saat melakukan “Coding” agar code yang kita hasilkan menjadi Clean. Namun pada kesempatan kali ini saya akan membahas beberapa tips dari sekian banyak tips untuk menjadikan code yang kita buat menjadi lebih “Clean”.
1. Aturan Penamaan (Naming Convention)
Saat kita akan memberikan nama pada sebuah variabel atau fungsi, sebisa mungkin kita membuat nama yang jelas dan “berarti”. Berikut adalah contoh pada project PPL saya
Dapat dilihat pada code di atas, fungsi handleLogin() merupakan sebuah fungsi yang meng handle fungsionalitas yang berhubungan dengan login user. Dengan hanya membaca nama fungsi nya, kita dapat mengetahui apa yang dilakukan fungsi tersebut secara garis besar.
DRY (Don’t Repeat Yourself)
DRY adalah sebuah konsep dimana kita tidak boleh membuat sebuah atau beberapa line yang sama persis dan memiliki fungsionalitas yang sama. Sebisa mungkin kita membuat sebuah file atau fungsi terpisah yang menghandle logic atau bagia yang sama agar tidak terjadi duplikasi code yang sama.
Berikut adalah contoh pada project PPL saya :
Dapat dilihat bahwa pada kedua component React Js di atas, kita menggunakan component NavbarUser yang sama. Dimana file NavbarUser tersebut terletak di file terpisah. Hal ini merupakan salah satu penerapan DRY dimana kita tidak mengulang code yang sama untuk membuat implementasi dari NavbarUser di beberapa file.
Layout Formatting
Selain dari sisi teknikal, kita juga harus memperhatikan kerapian dari code kita. Beberapa hal yang harus diperhatikan adalah :
- Indentasi yang rapi dan seragam untuk setiap file.
- Penulisan yang sesuai dengan panduan penulisan kode bahasa pemrograman yang digunakan
- Menghapus dead code yaitu code yang di comment karena sudah tidak digunakan lagi.
Pada project PPL kami kali ini, kami menggunakan Linter. Linter adalah sebuah tools yang membantu kita melakukan pengecekan terhadap code kita. Pengecekan ini termasuk pengecekan indentasi, import yang tidak dipakai dan analisis lain terhadap kualitas code kita.
Penutup
Penerapan Clean Code adalah hal yang sangat baik untuk kita lakukan. Selain membuat code mudah di maintenance, Clean Code juga akan membuat code yang kita buat lebih mudah untuk dibaca oleh orang lain yang akan melanjutkan code kita. Dengan membuat code yang berkualitas, maka kita juga akan menjadi seorang programmer yang berkualitas juga.
Sekian artikel tentang Clean Code pada kali ini. Semoga bermanfaat bagi teman teman semua. Terima kasih dan tetap semangat !