Bersihkan kodemu dengan prinsip Clean Code

sumber : https://blog.stoneriverelearning.com/10-clean-coding-techniques-that-every-coder-should-know/

Bagi kalian yang sangat menyukai bersih-bersih tentunya tidak tahan bukan melihat sesuatu yang berantakan dan kotor, ternyata dalam pengembangan software juga ada loh bersih-bersih yaitu kodenya. Pembersihan yang dimaksud adalah pembersihan yang berdasarkan prinsip clean code. Seperti yang sudah dibahas pada artikel sebelumnya terkait TDD (Test Driven Development) telah disinggung bahwa pada saat tahap refactor, yaitu refactor yang berdasarkan clean code. Lalu apa itu clean code?

Apa itu Clean Code?

Kalimat tersebut menggambarkan bagaimana clean code itu. Komputer tentu saja dapat membaca semua code apabila sesuai kaidahnya, lalu bagaimana dengan manusia? Terutama pada saat menjalankan suatu proyek, dan code yang kita buat tentunya harus dapat dimengerti oleh anggota yang lain bukan?

Mengaplikasikan clean code mungkin menyebabkan proyek berjalan lambat diawal, namun akan mempercepat pada pertengahan hingga akhir proyek. Clean code memiliki arti luas dalam artikel ini akan dibahas beberapa clean code principles yaitu Simple, DRY, Readable, dan YAGNI

Clean Code Principles dan Implementasi pada Proyek

Simple

Prinsip ini dapat mengikuti Single Responsibility Principle (SRP) berarti membuat kode sesimpel mungkin, setiap modul, class, atau fungsi, harus memiliki satu tanggung jawab saja, tidak ada yang lainnya. Hal tersebut bermaksud fokus pada satu tujuan dan memiliki fungsi untuk tujuan tersebut.

Pada kode diatas terlihat ada suatu class Data, class ini bertujuan untuk mengubah json ke dalam bentuk class yang bernama Data sehingga dapat dengan mudah pengambilan data pada json untuk diolah data yang didapat.

DRY

DRY (Don’t Repeat Yourself) hal ini bermaksud mengurangi duplikasi data, selalu ingat ketika menuliskan code yang sudah berulang kali digunakan. Kemudian refactor dengan mengubah suatu code dapat sehingga menjadi reusable.

Salah satu penggunaannya yaitu dari hal yang simpel, seperti penyimpanan variabel code yang selalu dipakai dan kemudian menjadikannya suatu file atau fungsi yang dapat digunakan berulang.

Readable

Suatu code harus dapat mudah dimengerti. Seperti penamaan, struktur, spacing, dan flow harus sudah diperkirakan pada awal pengerjaan proyek. Mungkin dapat mengikuti aturan dari framework yang digunakan.

Berikut adalah beberapa contoh yang membuat suatu code readable.

  • Penggunaan nama yang bermakna

Nama variabel, fungsi, atau class haruslah bermakna khususnya dalam proyek tim, agar dapat dengan mudah dimengerti maskud dan tujuan code tersebut.

  • Pemecahan suatu code apabila sudah terlalu panjang

Bagaimana jadinya bila semua proyek yang dikerjakan menjadi 1 file saja, bayangkan betapa sulitnya kita mengerti kode yang dibuat terebut. Salah satu cara agar mudah dimengerti pemecahan code menjadi suatu class atau fungsi baru sehingga kita bisa melihat bagian-bagian dari struktur code yang dibuat.

Penggunaan Body untuk bagian body dari suatu widget dan disimpan pada directory components
  • Pengunaan comment untuk penjelasan suatu fungsi yang dibuat

Hal ini cukup perlu apabila penamaan code terlalu panjang untuk menjelaskan tujuannya. Namun jangan over dalam penggunaannya.

YAGNI (You Aren’t Gonna Need It)

Janganlah buat suatu fungsi yang belum tentu diperlukan. Seperti yang telah disinggung diatas yaitu pembuatan suatu fungsi, namun fungsi yang dimaksud adalah fungsi yang akan selalu digunakan atau fungsi hasil pemecahan suatu code yang sudah terlalu panjang. Selain itu penggunaan comment yang berlebihan juga tidak perlu dilakukan, justru hanya membuat code yang kotor.

Kelebihan menerapkan Clean Code

  • Code menjadi lebih mudah debuggingDengan menerapkan clean code pada proyek, akan membuat lebih mudah dalam pencarian bug dan mudah juga dalam menyelesaikannya.
  • Code menjadi lebih maintanableDalam berjalannya proyek, tentunya akan terdapat maintenance, untuk menambah suatu fitur, atau merubah code. Dengan clean code hal tersebut menjadi lebih mudah karena sudah terstruktur proyek yang dibuat.
  • Mengurangi biaya atau waktu — Dengan clean code, kode yang kita buat sudah terstruktur dan mudah untuk beradaptasi pada perubahan. Dalam pengerjaan segala perubahan tentunya akan menggunakan biaya atau waktu. Sehingga dengan clean code hal terebut dapat dikurangi.

Kesimpulan

Clean code sangatlah baik untuk diterapkan dalam proyek yang dibuat terlebih pada proyek tim. Clean code mungkin menyebabkan proyek berjalan sedikit lambat diawal namun dapat mempercepat pada pertengahan pengerjaan sehingga menjadi lebih efektif dan efisien.

Referensi

Mahasiswa Fasilkom UI angkatan 2018

Mahasiswa Fasilkom UI angkatan 2018