Stop Ngoding Asal-Asalan!

Pernah ga sih kalian membuat sebuah code secara asal-asalan? Misalnya, memberi nama yang asal-asalan untuk sebuah variabel, fungsi, class, atau bahkan nama dari file itu sendiri? Dengan dalih:

Ah ngapain bikin rapih-rapih, lagian nantinya gabakal dibuka lagi.

Percaya deh, kebiasaan ini adalah kebiasaan yang buruk. Bayangkan jika suatu saat kalian membutuhkan potongan code tersebut karena kalian lupa cara implementasinya namun ingat pernah “ngoding” ini di masa lalu. Bayangkan jika kalian butuh implementasinya pada saat itu juga. Namun saat kalian membuka code tersebut, yang kalian temukan hanyalah sekumpulan code yang memiliki penamaan variabel yang buruk, serta dokumentasi yang minim atau bahkan tidak ada dokumentasi sama sekali. Mau tidak mau kalian terpaksa membacanya berulang kali karena kesulitan dalam memahami code tersebut. Tentu akan sangat menyebalkan bukan? terlebih lagi jika seandainya kalian dikejar oleh waktu.

Bayangkan juga jika kalian membuat code tersebut untuk sebuah proyek, yang jelas akan dibaca dan digunakan oleh tim kalian, baik sekarang maupun di masa yang akan datang. Tentu akan sangat merepotkan tim kalian dalam memahami code tersebut. M̶e̶m̶a̶h̶a̶m̶i̶ ̶c̶o̶d̶e̶ ̶s̶a̶j̶a̶ ̶s̶u̶d̶a̶h̶ ̶s̶u̶s̶a̶h̶,̶ ̶a̶p̶a̶l̶a̶g̶i̶ ̶k̶a̶l̶a̶u̶ ̶c̶o̶d̶e̶n̶y̶a̶ ̶j̶e̶l̶e̶k̶.̶

Ilustrasi Good Code vs. Bad Code

Agar code kita lebih mudah dibaca dan dipahami, baik untuk diri kita sendiri maupun anggota tim, terdapat suatu istilah bernama Clean Code.

Jadi, clean code itu apa sih?

Singkatnya, clean code adalah code yang mudah dipahami dan mudah untuk diubah.

Jelasnya, clean code adalah code yang memiliki format yang benar serta disusun dengan baik dan bersih agar code tersebut mudah dibaca, mudah untuk dipahami, mudah untuk ditelusuri, serta mudah untuk diubah bagi siapapun yang akan melanjutkan pekerjaan kita nantinya. Clean code ini sangat penting untuk diterapkan jika kita sedang bekerja dalam tim, agar anggota tim tidak kebingungan saat mereview ataupun menggunakan code tersebut, serta dapat memangkas waktu, tenaga, dan biaya saat melakukan maintaining code.

Kriteria dari clean code adalah sebagai berikut:

  • Mudah untuk memahami alur dari aplikasi keseluruhan
  • Mudah untuk memahami bagaimana objek-objek yang berbeda saling berkolaborasi.
  • Mudah untuk memahami role dan tugas-tugasnya untuk setiap class
  • Mudah untuk memahami apa yang dilakukan oleh suatu method
  • Mudah untuk memahami kegunaan dari setiap ekspresi dan variabel

Jadi, bagaimana cara agar code yang dibuat dapat sedikit lebih bersih?

Berikut adalah beberapa cara dalam menerapkan clean code:

  1. Meaningful Names
    Penamaan suatu variabel haruslah jelas dan langsung dapat dipahami apa kegunaannya, serta sesuai dengan konteksnya. Pastikan nama variabel tersebut deskriptif namun tidak ambigu.
  2. Good Functions
    Sebuah fungsi/method hanya melakukan satu hal.
  3. Good Comments
    Memberi dokumentasi/penjelasan yang baik pada awal sebuah fungsi/method.
  4. Tested Code
    Code tests bertujuan untuk menjamin bahwa code yang telah dirancang benar-benar mengeluarkan output yang sesuai, serta meminimalisi hal-hal yang tidak diinginkan.
  5. Consistent Formatting
    Buat code kalian konsisten sehingga mudah untuk dipahami di kemudian hari. Serta dengan format yang bagus, code akan terlihat lebih rapi dan enak dipandang. Mungkin pada beberapa bahasa pemrograman, hal-hal seperti whitespace, indentasi, dan code placement tidak akan memengaruhi fungsionalitas dari code, namun akan sangat membantu dalam membaca dan memahami code jika dibandingkan dengan code yang tidak memiliki format yang jelas.

Juga ikuti cara penamaan sesuai dengan bahasa pemrograman yang digunakan, seperti Python yang menggunakan snake_case, Java yang menggunakan camelCase untuk variabel dan method serta PascalCase untuk penamaan class.

Kesimpulan

Menjaga code kalian bersih adalah hal yang bagus dan perlu untuk pertahankan. Dengan clean code, code tersebut akan mudah dibaca, mudah dimaintain, dan dapat memangkas waktu, biaya dan tenaga. Semoga artikel ini bermanfaat dan membantu kalian dalam menerapkan clean code.

Referensi:

--

--

Not a Writer :)

Love podcasts or audiobooks? Learn on the go with our new app.

Get the Medium app

A button that says 'Download on the App Store', and if clicked it will lead you to the iOS App store
A button that says 'Get it on, Google Play', and if clicked it will lead you to the Google Play store