Kebersihan adalah Sebagian dari Iman

Membuat sebuah program yang berfungsi adalah sesuatu yang tidak sulit untuk dikerjakan, namun membuat sebuah program yang berfungsi dan mudah dipahami adalah tugas yang menjadi tantangan. Kemudahan memahami sebuah code merupakan hal yang sangat penting karena dapat mempercepat proses development secara signifikan, apalagi jika proses tersebut tidak dilakukan oleh tim yang sama.

It is not enough for code to work — Robert C. Martin, Clean Code: A Handbook of Agile Software Craftsmanship

Pelaksanaan prinsip clean code merupakan salah satu cara untuk membantu orang-orang yang akan membaca code kita. Hal-hal yang harus dilakukan dalam penerapan prinsip clean code adalah sebagai berikut:

Penamaan Function, Variable, dan Class yang Jelas

Penamaan yang baik menurut prinsip clean code adalah penamaan yang jelas, sesuai dengan isi dari variable, function, atau class tersebut. Function biasanya menggunakan nama berbentuk kata kerja, sedangkan Class menggunakan nama berbentuk kata benda. Penamaan yang jelas memudahkan pembaca untuk dapat memahami code kita dengan cepat.

Function yang menggunakan kata kerja dan menjelaskan tujuan fungsi tersebut

Hindari Ambiguitas pada Control Structure

Penulisan control structure yang jelas dapat mempermudah pembaca code untuk memahami flow dari sebuah code.

Conditional yang jelas mempercepat pembacaan code

Dengan penulisan conditional yang jelas, pembaca tahu alasan code tersebut masuk ke blok if, else if, else, atau yang lainnya.

Gunakan Coding Standard / Coding Style yang Biasa Digunakan

Masing-masing bahasa pasti memiliki standard penulisan code yang berbeda-beda. Dalam proyek ini, kelompok kami menggunakan bahasa TypeScript yang memiliki standard penulisan code yang mirip dengan JavaScript. Salah satu contoh dari standard penulisan code di TypeScript yang umum adalah penamaan interface yang diawali dengan huruf I kapital

Penamaan interface

Penerapan clean code dari segi style dan standard dapat dibantu dengan menggunakan linter. Linter akan secara otomatis mengeluarkan error jika dijalankan dan menemukan potongan code yang tidak sesuai dengan rule dari linter tersebut. Rules linter dan keketatannya dapat diatur sedemikian rupa.

Pengaturan rule linter (TSLint)

Dalam proyek pribadi atau proyek skala kecil, clean code sering kali diabaikan karena proyek-proyek tersebut seringkali tidak berkelanjutan, namun dalam proyek skala perusahaan yang menargetkan kelanjutan selama bertahun-tahun, clean code sangatlah penting untuk menghindari bugs tidak perlu. Clean code juga dapat mengurangi biaya development suatu proyek karena dapat mengurangi waktu yang diperlukan bagi developers baru dalam memahami legacy code.