What Makes a Code Clean?

Dalam pengembangan software sering sekali terdengar istilah clean code, sebenarnya apa itu clean code?

Code yang “clean” adalah code yang mudah dimengerti. Dengan adanya clean code proses pengembangan software bisa jauh lebih cepat, karena clean code membuat code yang lebih rapih serta mudah dibaca oleh orang lain sehingga pada proses pengembangan dalam tim, anggota lain tidak terhambat hanya karena sulit memahami kode yang dibuat oleh anggota lain.

Berikut beberapa aturan clean code beserta contohnya,

1. Komentar yang Efisien

Komentar ini pada umumnya digunakan untuk menjelaskan kode yang kurang jelas. Namun pada clean code sebaiknya kode yang kurang jelas diperbaiki agar lebih mudah dimengerti dan komentar hanya digunakan jika terdapat kode yang kompleks sehingga dibutuhkan penjelasan tambahan agar lebih mudah dimengerti oleh orang lain.

2. Penamaan yang Sesuai

Penamaan yang diberikan pada suatu variable, function, dan method sebaiknya deskriptif (menggambarkan apa yang dilakukan oleh function tersebut atau apa yang disimpan pada variable tersebut), mudah dibaca, memiliki perbedaan yang signifikan dari satu sama lain dan juga mengikuti acuan umum yang sudah ditetapkan untuk masing-masing bahasa pemrograman.

Gambar diatas merupakan contoh suatu fungsi yang menggunakan penamaan yang sesuai dengan tujuan fungsinya, yaitu memanggil API Admin Delete Post

3. Function yang Simple dan Efektif

Pastikan setiap masing-masing fungsi/method hanya melakukan satu hal dan sebaiknya fungsi/method tersebut menghindari terjadinya side effect yang bisa memengaruhi hal lain yang tidak termasuk dalam tujuan fungsi/method tersebut.

Gambar diatas merupakan contoh suatu fungsi yang hanya melakukan satu hal yaitu melakukan formatting string pada tanggal sebuah post dibuat

4. Mengantisipasi Error dengan Exception

Developer sebaiknya menerapkan kode yang dapat digunakan untuk mengantisipasi semua kemungkinan error dengan menggunakan exception handling.

Fungsi pada gambar tersebut menangani kemungkinan terjadinya error apabila sebuah community tidak ditemukan dalam database dengan menggunakan HTTPException dimana jika error tersebut terjadi maka akan dimunculkan Http Code 404 dengan deskripsi yang sesuai dengan errornya

5. Menghindari Duplicate Code dan Unused Code

Pada suatu program jangan ada kode yang muncul lebih dari sekali, hal ini biasa terjadi apabila dua developer mengerjakan dua buah task pada waktu bersamaan dan secara tidak sadar mengerjakan kode yang mirip, hal ini ditangani dengan penggunaan konsep-konsep seperti Object Oriented Programming atau menggunakan Design Pattern. Selain duplicate code, kita juga perlu menghindari adanya unused code dimana terdapat kode yang tidak punya kegunaan apapun dalam keseluruhan program, hal tersebut sebaiknya dihapus untuk mempercepat runtime program.

Sekian informasi yang bisa saya sampaikan terkait dengan Clean Code, semoga informasi yang saya berikan bisa membantu.

References

https://gist.github.com/wojteklu/73c6914cc446146b8b533c0988cf8d29

https://blog.dot.co.id/5-cara-mudah-menerapkan-clean-code-b2e0ec1b860e