Berfungsi belum cukup, Bersih sempurna!
Dalam mendalami pekerjaan sebagai software developer, terkadang kita harus melanjutkan atau memperbaiki software yang sudah dibuat sebelumnya oleh orang lain. Karena itu, kemampuan analisis untuk mengerti apa yang sebuah code lakukan merupakan suatu hal yang penting. Namun, pernahkah kamu para software developer menemukan code seperti ini?
Dengan membaca code diatas, bahkan software developer yang senior pun akan kesulitan untuk memahami apa yang dilakukan oleh code tersebut. Namun, hal tersebut bukan menjadi kesalahan dari software developer yang tidak dapat memahami code tersebut melainkan kesalahan dari software developer yang membuat code tersebut. Itulah mengapa, fungsionalitas code bukanlah satu-satunya hal yang harus diperhatikan para software developer namun juga “kebersihan” code tersebut. Clean code membuat code yang kita buat tidak hanya dapat dimengerti oleh kita sebagai pembuat code, namun dapat dengan mudah dimengerti oleh sesama software developer.
WHAT IS CLEAN CODE?
Menurut Grady Booch, penulis buku “Object Oriented Analysis and Design with Applications”, menuturkan bahwa clean code adalah :
“Clean code is simple and direct. Clean code reads like well-written prose. Clean code never obscures the designer’s intent but rather is full of crisp abstractions and straightforward lines of control.”
Secara singkat, clean code adalah istilah untuk menggambarkan code yang memiliki format yang benar serta disusun dengan baik sehingga dapat dengan mudah dimengerti oleh orang lain. Dalam mengembangkan software dengan metode Agile, sering kali ada lebih dari 1 software developer yang mengerjakan atau memodifikasi bagian yang sama dari sebuah code secara bergantian. Inilah mengapa, clean code dalam penerapan metode Agile sangat penting karena mempercepat proses pengembangan software dan memperlancar komunikasi. Dengan clean code, antar developer tidak perlu saling bertanya apakah maksud dari code yang dibuat sebelumnya yang tentu saja akan membuat waktu pengembangan menjadi lebih lambat.
HOW TO MAKE CLEAN CODE?
Untuk membuat clean code yang dapat dengan mudah dimengerti, ada beberapa hal yang harus diperhatikan setiap software developer. Hal-hal tersebut diantaranya :
- Penamaan yang baik
Penamaan dari setiap variable, method, serta class dari code yang dibuat harus diperhatikan dengan baik. Seluruh penamaan harus “meaningful”, sehingga orang lain akan tau apa isi dari variable tersebut ataupun kegunaannya. Penamaan method juga sebaiknya adalah kata kerja, sedangkan penamaan class sebaiknya adalah kata benda.
2. Penulisan Fungsi yang Simpel dan Efektif
Penulisan isi method pun perlu diperhatikan. Sebuah method sebaiknya hanya mengerjakan 1 fungsi, sesuai dengan “Single Responsibility Principle” (SRP). Jika suatu method terlalu panjang dan mengerjakan banyak “tugas”, maka method tersebut dapat dipecah jadi beberapa method kecil yang saling berhubungan. Argumen dari method tersebut pun harus diperhatikan, usahakan argumen dari suatu method tidak lebih dari 3 argumen.
3. Exception Handling
Dalam membuat code, seringkali bahwa sebenarnya kita tau bahwa dalam section yang sedang kita buat berpotensi terjadi error. Dalam keadaan seperti itu, alangkah lebih baik jika kita melakukan handling terhadap error umum yang mungkin terjadi, sehingga user tidak melihat error tersebut.
4. Komentar yang efisien
Sering kali kita mengubah code yang tidak terpakai menjadi comment agar tidak dijalankan oleh compiler. Namun, hal tersebut bukanlah hal yang baik untuk dilakukan. Comment yang ada pada kode sebaiknya hanya perlu digunakan untuk menjelaskan fungsi suatu method atau variable yang memang sulit dimengerti. Untuk fungsi dan variable lain yang kiranya mudah dimengerti, tidak perlu menggunakan comment.
5. Dont Repeat Yourself (DRY)
DRY berarti tidak terjadi duplikasi kode. Jika kita melakukan hal yang hampir sama beberapa kali, maka baiknya dijadikan sebuah method atau dijadikan sebuah variable agar tidak menulis berulang-ulang, hanya memanggil method yang beresangkutan.
6. Layout Formatting
Menerapkan formatting kepada code yang sesuai dengan indentasi yang mudah dibaca. Dapat menggunakan tools yang membantu penulisan format yang benar untuk masing-masing bahasa pemrograman.
Penerapan Clean Code Pada Pengerjaan Proyek
Berikut adalah contoh usaha saya dan kelompok saya dalam menerapkan clean code untuk pengerjaan proyek PPL Fasilkom UI 2021.
- Terlihat pada penggunaan nama method dan variable yang dibuat, kami mencoba untuk membuat nama tersebut sejelas mungkin sesuai dengan isi variable dan method tersebut.
- Penamaan dengan format pemisah “_” pada nama variable dan method merupakan layout formatting sesuai dengan bahasa pemrograman python.
- Terlihat bahwa kami tidak menggunakan Comment apapun, karena dengan nama yang sudah jelas dan algoritma yang tidak terlalu rumit, tidak perlu dijelaskan dengan comment tambahan
- Terlihat adanya if else yang menjadi exception handling dari method kami, dimana jika user type yang mengakses method tersebut bukan yang sesuai, maka langsung dialihkan ke halaman utama.
- Penggunaan indentasi yang sesuai bahasa pemrograman python agar lebih rapih dan berjalan sesuai
- Penggunaan Linter berupa PyLint, untuk membantu kami menjaga kebersihan code.
Sekian pengetahuan singkat mengenai clean code dan usaha penerapan clean code dalam proyek dunia nyata, semoga membantu^-^.
Referensi:
