Clean Code vs Dirty Code
Sudah seharusnya bagi seorang programmer untuk tidak hanya mementingkan bagaimana software yang dibuatnya bisa berjalan, tapi juga memiliki semangat software craftmanship. Salah satu aspek software craftmanship adalah bagaimana menulis source code dengan baik sehingga software dapat maintainable dan mudah dikembangkan untuk jangka waktu yang panjang.
Pada buku Clean Code: A Handbook of Agile Software Craftmanship banyak pembahasan mengenai clean code. Versi singkatnya bisa kita baca di tautan berikut.
Pada perkuliahan PPL ini, kami diminta untuk memiliki komitmen dalam menerapkan Clean Code pada proyek-proyek yang kami kerjakan. Hal tersebut dikarenakan dengan menggunakan clean code, kualitas software yang kami buat tidak hanya fungsionalitasnya yang berjalan dengan baik, tapi juga memberikan software yang memiliki code quality yang baik, maintainable, dan aman.
Berikut beberapa cara mudah menerapkannya:
1. Penamaan Variable, Method, dan Class Harus Jelas
Harus diakui seringkali kita membutuhkan waktu lama untuk memikirkan sebuah “nama” variable yang akan kita tuliskan, dan berakhir dengan menuliskan sebuah variable yang singkat, padat, dan tidak jelas. Berikut contohnya:
Gunakanlah nama-nama variable yang jelas dan mudah dimengerti. Pastikan format penulisan konsisten untuk semua source code. Berikut contoh penamaan yang jelas:
Penamaan yang jelas dan konsisten dapat memudahkan dev-team untuk melakukan debugging.
- Variable, dan Class harus memiliki nama frasa kata benda seperti Customer, Account, and AddressParser.
- Hindari kata-kata seperti Processor, Manager, Data, atau info nama Class tersebut untuk menjadi nama Class.
- Nama Class tidak harus berupa kata kerja.
- Method harus memiliki nama frasa kata kerja seperti postPayment, deletePage, save, atau address.
- Setter dan Getter harus diawali dengan set dan get.
- Jangan menyingkat nama
- Gunakan variables atau method yang mendeskripsikan fungsinya.
2. Clean Code is DRY
DRY merupakan akronim dari “Don’t Repeat Yourself”. Jika kita menggunakan hal yang sama di banyak code, dapat menimbulkan banyak duplicate code. Jika kita melihat ada pattern yang ditemukan dari kode tersebut, artinya “it is time for DRYing”. Contohnya seperti gambar di bawah ini:
3. Hapus kode yang tidak digunakan
Seringkali ketika kita tidak jadi menggunakan barisan kode, kita tidak langsung menghapusnya, melainkan kita meng-comment nya. Hal tersebut dapat membuat dirty code, contohnya pada kode dibawah ini:
Pada gambar tersebut, terlihat bahwa baris onLoadUser() tidak digunakan, jadi sebaiknya dihapus dan menjadi seperti di bawah ini:
Penutup
Sumber:
