Apa itu clean code?

Adalah istilah dari sintaks dari code yang mudah dibaca, dipahami, dan diubah oleh programmer.

Kenapa clean code?

Dalam mengerjakan suatu code, kita pasti akan mendapati hal-hal berikut ini

1. Work Collaboration

Kita akan bekerja sama dalam sebuah tim saat mengerjakan suatu proyek. Tentunya kita harus menciptakan kode yang dapat dipahami oleh seluruh tim agar tidak terjadi kesalahpahaman.

2. Feature Development

Dengan adanya clean code kita akan lebih gampang membaca dan memodifikasi atau mengembangkan fitur dalam kode dengan mudah

3. Faster Development

Clean code juga akan membuat mudah dan cepat mempelajari suatu kode. Sehingga kita tidak perlu memakan banyak waktu hanya untuk memahami kode yang diberikan.

Karakteristik Clean Code

Terdapat beberapa karakteristik kode yang harus diketahui dan dipahami, antara lain:

1. Mudah dipahami

Suatu variable dalam code baiknya diberi penamaan sesuai dengan maksud variable tersebut

2. Mudah dieja dan dicari

Memberikan penamaan variable dalam code dengan alias yang mudah diingat di kemudian hari.

3. Singkat namun mendeskripsikan konteks

Penamaan menyesuaikan dengan konteks yang ada namun diperjelas secara singkat

4. Konsisten

Konsisten dapat dilihat dari gaya penulisan yang sudah ada. Dapat menggunakan camelCase, uppercase, dll secara konsisten. Konsisten juga dapat diartikan kita harus konsisten dalam penamaan suatu method, variable, dan lain sebagainya.

5. Hindari penambahan konteks yang tidak perlu

Konteks yang diulang-ulang padahal sudah jelas baiknya tidak perlu ditambahkan dalam code.

6. Komentar

Memberikan komentar dalam sebuah code dapat membantu seorang programmer mengingat maksud dari codingan tersebut kemudian hari. Berikan komentar pada suatu blok code tertentu yang dirasa perlu dijelaskan, tidak perlu setiap baris code.

7. Good Function

Membuat function baiknya tidak menginputkan banyak argument. Baiknya kita membuat sebuah objek dalam argument tersebut. Hindari juga efek samping yang akan terjadi terutama dalam menggunakan global function. Jangan merubah value asli, lebih baik mengggunakan variable baru.

8. Gunakan Konvensi

Kita dapat mengikuti style guide yang ada agar code kita lebih clean dan sesuai standar yang ada.

9. Formatting

Membuat format tertentu yang mengatur tampilan code didalamnya seperti lebar baris, indentasi, dan jarak antar fungsi agar kita dapat memahami code yang telah kita buat.

Clean Code Principle

1. KISS (Keep It So Simple)

Hindari membuat fungsi yang dibuat untuk melakukan A, B dan C. Buatlah fungsi yang simple dan berfokus pada kegunaannya.

Tips agar code selalu Keep It So Simple:
- Fungsi atau class harus kecil
- Fungsi dibuat untuk melakukan satu tugas saja
- Jangan gunakan terlalu banyak argument pada fungsi
- Harus diperhatikan untuk mencapai kondisi yang seimbang, kecil, dan jumlahnya minimal

2. DRY (Don’t Repeat Yourself)

Jangan menduplikasi sebuah code, seperti membuat satu fungsi melakukan hal yang sama. Duplikasi terjadi karena sering copy paste. Untuk menghindari baiknya membuat fungsi yang dapat digunakan berulang-ulang agar terhindar dari duplikasi.

Tujuan dari clean code : Refactoring

Adalah proses restrukturisasi kode yang dibuat, dengan cara mengubah struktur internal tanpa mengubah perilaku eksterbal. Prinsip KISS dan DRY bisa dicapai dengan cara refactor.

Teknik Refactoring

• Membuat sebuah abstraksi, membuat list fungsi-fungsi dari sebuah code
• Memecah kode dengan fungsi/class
• Perbaiki penamaan dan lokasi kode
• Deteksi kode yang memiliki duplikasi