“One does not simply write clean code on the first try”
Sebagai programmer yang bekerja secara individual, mungkin kita terbiasa untuk menyusun code kita dengan sesuka hati. Yang penting, program yang kita tulis bisa berjalan dengan baik, pikir kita. Akan tetapi, setelah beberapa bulan kemudian, coba kita baca code yang pernah kita tulis dengan format dan penamaan yang sesuka hati sebelumnya, apakah kita dapat dengan mudah ingat dan paham dengan code kita sendiri? Atau, jika code kita dibaca oleh orang lain, apakah orang lain dapat dengan cepat dan mudah untuk mengerti dan memodifikasi code yang kita buat?
Agar dapat mengatasi permasalahan yang ada di atas, kita dapat menerapkan clean code. Clean code adalah salah satu cara yang biasa dipakai dalam metode pengembangan software yang agile, karena code yang ditulis cenderung selalu berubah dan bertambah. Dalam clean code, format penulisan harus dibuat sedemikian rupa agar programmer lain bisa dengan mudah membaca, mengerti, dan memodifikasi code tersebut. Dengan begitu, kita bisa menghemat cost, khususnya dari segi waktu karena waktu yang dibutuhkan untuk memahami dan memodifikasi code menjadi lebih singkat.
Beberapa tips yang dapat digunakan untuk mulai menulis clean code adalah sebagai berikut:
1. Buatlah code dengan coupling rendah dan cohesion yang tinggi
Dengan code yang coupling-nya rendah dan cohesion yang tinggi, code menjadi lebih simpel dan mudah dipahami karena tidak menggabungkan terlalu banyak fungsi dalam code. Semakin banyak fungsi yang tercampur aduk dalam code, semakin besar kemungkinan adanya bug. Hal itu dapat mempersulit proses pencarian penyebab terjadinya error.
2. Don’t repeat yourself
Sebisa mungkin, jangan mengulangi class atau fungsi yang sama dalam code.
3. Gunakan penamaan dan spacing yang konsisten
Misalnya, gunakan upper camel case untuk nama class, camel case untuk nama fungsi dan variabel, dan tabulasi untuk indentation sebesar 4 spasi. Dengan begitu, programmer lain juga dapat menyesuaikan cara penulisan sehingga code dapat lebih rapi.
4. Kurangi comment
Sesuai dengan kuliah umum mengenai clean code yang dibawakan oleh kakak mentor dari KMK Labs, code harus ditulis sejelas mungkin sehingga penulisan comment dapat diminimalisasi (atau bahkan tidak ada sama sekali). Banyak kasus dimana programmer seringkali mengubah code, tetapi lupa mengubah comment yang menyertai code-nya. Oleh karena itu, pengurangan comment akan membantu agar code tidak membingungkan untuk dimengerti.
Untuk membantu clean code (khususnya dari segi indentasi), kita dapat menggunakan bantuan dari beberapa tools. Tools yang digunakan untuk project PPL kami antara lain:
1. Sublime Text Editor
Dengan menggunakan Sublime Text Editor, saya dapat mengatur berapa spaces yang ingin saya gunakan tiap satu tab. Dalam proyek PPL kami, kami sepakat menggunakan 2 spasi untuk file HTML dan JS serta 4 spasi untuk file CSS.
2. W3C Markup Validation Service
Tool ini digunakan untuk mengecek ada atau tidaknya error dari file HTML, seperti kelengkapan tag dari suatu file HTML atau kelengkapan closing slash.
3. CSSComb dan Alignment
CSSComb merupakan salah satu plugin yang dimiliki Sublime untuk merapikan indentasi dan order yang tepat bagi file CSS dan JavaScript.
“Always code as if the guy who ends up maintaining your code will be a violent psychopath who knows where you live.” — Martin Golding
