Clean Code

“Programs are meant to be read by humans and only incidentally for computers to execute.”

― Donald Knuth

Sebuah code dapat dikatakan baik jika kita dapat mengerti maksud code tersebut dengan mudah tanpa bertanya kepada pembuatnya.

Beberapa karakteristik clean code :

1. Elegan — Clean code harus menyenangkan untuk dibaca sehingga membuat kita tersenyum ketika membacanya.
2. Fokus — Setiap fungsi, setiap kelas, setiap modul hanya dibuat untuk 1 tujuan/hal yang sama sekali tidak terganggu dan tidak terpolusi oleh perincian disekitarnya
3. Simpel
4. Don’t duplicate yourself — Tidak boleh ada kode yang duplikat
5. Menjalani semua test
6. Meminimalkan jumlah entitas seperti kelas, fungsi, dan sejenisnya.

Bagaimana cara membuat Clean Code?

1. Meaningful Names

Nama sebuah variabel, kelas, ataupun fungsi haruslah menjelaskan kenapa mereka dibuat, apa yang dilakukan, dan bagaimana cara menggunakannya. Jika sebuah nama memerlukan komentar untuk penjelasan tambahan, maka nama tersebut belum dapat disebut meaningful names.

int a = 100 //a adalah variable yang menyimpan banyak kolom suatu tabel

Potongan kode diatas merupakan kode yang menunjukkan penamaan variabel yang baik, nama variabel yang lebih baik adalah

int columnNumber = 100

Best practice penamaan suatu nama variabel, kelas, maupun fungsi tergantung dari bahasa pemrograman yang digunakan. Pada bahasa Java, best practice untuk penamaan variabel adalah camel case sedangkan pada Python adalah snake case.

Nama Class — Nama sebuah kelas atau objek haruslah berupa kata benda seperti Customer, Person, Cat, dsb. Sebuah nama kelas tidak boleh berupa kata kerja ataupun kata sifat.

Nama fungsi — Nama sebuah fungsi haruslah berupa kata kerja seperti deletePage, save, createAccount, dsb.

2. Small Functions

Terdapat dua aturan dalam membuat sebuah fungsi, pertama sebuah fungsi haruslah kecil, yang kedua adalah sebuah fungsi harus lebih kecil dari itu. Sebuah blok kode di dalam if statement, while statement, dan sebagainya sebaiknya hanya berisi 1 baris kode. Mungkin 1 baris ini dapat berupa pemanggilan fungsi. Penerapan ini tidak hanya membuat sebuah enclosed statement kecil namun juga memberikan dokumentasi yang baik karena pemanggilan fungsi di dalamnya dapat mempunyai nama yang deskriptif.

Selain itu, sebuah fungsi tidak boleh memiliki lebih dari 3 argumen. Fungsi yang memiliki lebih dari 3 argumen bisa jadi tidak mempunyai fokus yang tinggi alias melakukan lebih dari 1 hal. Jika seandainya sebuah fungsi benar-benar membutuhkan lebih dari 3 argumen, beberapa argumen tersebut dapat dibungkus menjadi sebuah objek.

3. Comments

Jika kita merasa kode yang kita buat masih membutuhkan komentar, maka kita telah melakukan kekeliruan. Idealnya, komentar tidak dibutuhkan sama sekali, kode yang kita buat harusnya sudah menjelaskan semuanya. Terdapat komentar yang legal untuk ditulis, yaitu copyright dan licenses statements.

Membuat kode yang bersih memang menghabiskan banyak waktu. Namun kita harus memulai secara perlahan dan konsisten. Sejatinya kode yang kita buat nantinya akan dibaca oleh orang lain. InsyaAllah jika kita membuat kode yang bersih, diri kita sendiri maupun orang lain akan mendapatkan manfaat darinya di masa yang akan mendatang, karena akan menghemat waktu yang diperlukan untuk memahami kode yang telah kita buat.