A Clean Code is a Good Code
Halo teman-teman, kembali lagi bersama Luqman! Kali ini kita akan membahas mengenai bagian code-nya sendiri, yaitu Clean Code!
Jadi, apa itu Clean Code?
Dalam menulis suatu code, sebetulnya seorang developer boleh menulisnya sebagaimana mungkin yang ia mau. Ia bisa menamai variabel dengan nama yang asal, ataupun mengabaikan indentasi. Namun, hal ini dapat membawa masalah pada dirinya sendiri.
Ya, memang developer tersebut dan tim-nya bisa mengerti code yang ia tulis. Tapi, jika suatu saat code tersebut ingin di-review oleh orang lain itu akan menimbulkan suatu masalah. Orang yang akan me-review bisa tidak mengerti code tersebut, meskipun logika dan algoritma di dalamnya sudah benar. Hal ini disebabkan karena kurangnya pembersihan code, atau code cleaning. Nah, permasalahan di sini adalah sang developer tidak mengimplementasi clean code, atau bisa dibilang ia telah menghasilkan dirty code. Jadi, clean code dapat diartikan sebagai cara penulisan dan dokumentasi sebuah code, mirip seperti jika seseorang ingin menulis buku yang tersusun rapih.
Nah, bagaimana cara untuk menghasilkan sebuah clean code? Berikut adalah beberapa cara penerapan clean code:
- Penamaan yang baik
Dalam penulisan sebuah fungsi / variabel, nama yang dipilih harus representatif terhadap apa yang ia lakukan / simpan dengan baik sehingga dapat dimengerti oleh orang lain. Selain itu, penggunaan konvensi nama atau penamaan sesuai aturan framework adalah ide yang bagus dan sebaiknya digunakan. Berikut adalah contoh penerapan pada SISIDANG-NG:
Code di atas mudah dimengerti, sebab terlihat jelas makna dari fungsi yang tercantum. Terlihat pula bahwa untuk memisahkan kata, digunakan underscore. Coba anda bandingkan dengan code di bawah:
2. Penulisan fungsi yang baik
Tiap penulisan fungsi harus dilakukan dengan jelas tujuan dan algoritmanya, sehingga developer lain yang menggunakannya dapat mengerti dan tidak keliru memahami flow dan behaviour code tersebut.
3. Penggunaan komentar yang sesuai dan efisien
Komentar tidak sebaiknya digunakan untuk memperbaiki code. Jika memang begitu, sebaiknya code diperbaiki dan ditulis ulang! Komentar sebaiknya hanya digunakan untuk memberi penjelasan tambahan pada suatu bagian code. Berikut adalah penerapan kami dalam SISIDANG-NG:
4. Layout formatting
Yang dimaksud formatting di sini adalah pengaturan penulisan seperti penggunaan huruf kapital, huruf kecil, dan sebagainya. Dalam pengaturan layout, kita dapat mengunakan tool linter sesuai dengan bahasa pemograman yang digunakan. Program kami menggunakan bahasa python dengan linter flake8.
5. Don’t repeat yourself (DRY)
Dalam penulisan code, usahakan untuk tidak menulis hal yang sama berulang kali. Alasannya, jika terdapat bug maka bug tersebut bisa terduplikasi di banyak tempat dan muncul kemungkinan tidak semua bug dapat ditemukan dan diperbaiki. Sebagai gantinya, kita dapat membuat bagian code tersebut menjadi sebuah method sehingga bisa dipanggil sesuai kebutuhan dan jika terjadi bug, kita hanya harus memperbaikinya 1 kali saja.
6.Error Handling
Terakhir, kita tetap perlu membuat error handling pada kode. Hal itu dilakukan untuk mengantisipasi error apa yang muncul jika terjadi sebuah error yang tidak sesuai dengan flow, dan memudahkan developer untuk melakukan proses debugging.
Baiklah, sekiranya hanya sampai itu yang ingin saya sampaikan kali ini mengenai clean code. Saya harap kita semua dadat mempelajari hal yang baru. Terima kasih sudah membaca, dan sampai bertemu lagi!
