Clean Code 101
Halo! Kembali lagi dengan postingan saya yang kesekian kalinya. Kali ini saya akan menjelaskan penerapan clean code dalam Teman Bisnis Customer Database and Analytics. Yuk simak!
Jadi Apaitu Clean Code?
Seperti namanya, clean code sendiri merupakan konsep dalam penulisan code oleh seorang programmer yang disusun dengan aturan yang baik dan benar. Clean code juga dapat menjadi tolak ukur kualitas suatu code yang telah diimplementasikan.
Nah apa sebenarnya tujuan penulisan clean code? Awalnya tim kami belum mengerti kenapa harus menerapkan clean code, padahal code yang diimplementasikan sudah dapat berjalan dengan baik. Hanya saja terkadang code yang diimplementasikan masing-masing anggota dalam tim sulit dibaca oleh anggota satu sama lain. Disinilah clean code bekerja, pembuatan code dengan menerapkan clean code dapat membantu programmer untuk membaca kode dengan lebih cepat!
Penulisan Clean Code
Berikut akan saya jelaskan apa saja poin yang dapat diterapkan dalam menuliskan clean code. Dan juga beberapa contoh implementasi dalam proyek kami untuk menerapkan poin yang telah dijelaskan. 😄
1. Komentar yang Efisien
Dalam kodingan yang ditulis, sebaiknya programmer menuliskan komentar secukupnya saja. Kode yang baik sebenarnya adalah kode yang dapat dipahami meskipun tidak ada komentar. Jadi, bisa saja kode yang dituliskan dengan diberi komentar masih belum tentu merupakan Good code.
Contoh pemberian komentar diatas diambil dari base.html untuk memberi tahu posisi script yang akan ditaruh di dalam html.
2. Penamaan
Ada beberapa poin yang dapat diambil dalam menuliskan nama (baik itu variable, function, dsb.). Yang pertama, tuliskan nama yang sesuai dengan tujuan dan tidak hanya asal huruf atau singkatan. Selanjutnya, pastikan penamaan tersebut bertujuan untuk satu hal atau konsep dan tidak lebih. Dalam tim kami, konvensi penulisan nama menggunakan pylint untuk menulis kode python.
Contoh penamaan dalam kodingan untuk mencari user dengan menggunakan uid (User ID) dalam US-6.
3. Penulisan Fungsi
Pastikan fungsi yang ditulis hanya memiliki satu tujuan dan tidak melakukan hal yang lebih. Sebisa mungkin hindari nested code yang terlalu dalam. Lalu letakkan error handling dalam kode untuk menghindari hal yang tidak diinginkan. Gunakan design pattern atau implementasi kode yang sudah ada!
Penulisan fungsi diatas diambil dari US yang saya kerjakan yaitu untuk mencari user berdasarkan UID. Fungsi tersebut sudah sesuai poin ini karena hanya memiliki satu tujuan yaitu mendapatkan user sesuai uid yang diinginkan, beserta test untuk mendapatkan user tersebut.
4. Code Smells
Hindari code smells! Banyak sekali masalah-masalah code smells dalam penulisan kode, kita tidak perlu menghafalkannya secara manual. Tim kami menggunakan pylint dengan plugin pylint-django sebagai linter untuk memberi tahu dimana letak code smells dan kesalahan format layout ketika mengimplementasikan kodingan.
Penutup
Don’t Repeat Yourself.
Dengan menerapkan clean code, tim dapat lebih mudah untuk membaca kodingan dengan kata lain dapat mempercepat proses development. Ada 4 poin yang perlu diperhatikan untuk menerapkan clean code. Keempat poin tersebut penting untuk diterapkan agar tercapai suatu kode yang dapat mudah di olah para anggota dalam tim.
Sekian tulisan kali ini, terima kasih sudah membaca!
Ciao
