Clean Code
Halo semuanya, kembali berjumpa dengan saya Bene. Kali ini saya akan membahas materi wajib yang belum pernah saya ambil sebelumnya, yaitu Clean Code.
Apa sih itu ?
Grady Booch, penulis dari Object Oriented Analysis and Design with Applications berpendapat bahwa Clean Code memiliki beberapa karakteristik, diantaranya :
- 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.
Singkatnya clean code akan membantu kita untuk membaca suatu code, serta mempermudah proses pengembangan suatu code.
Contoh penerapannya?
- Penamaan yang baik
Kita harus memberikan nama pada variable, method, dan code lainnya sesuai dengan aturan yang ditetapkan oleh suatu framework. Selain itu, dalam memberikan nama fungsi / variabel harus mengandung makna yang jelas sehingga mudah dimengerti oleh orang lain. Contoh penerapan dalam kelompok kami adalah seperti berikut :
Kode diatas akan mudah dimengerti oleh orang lain dibandingkan dengan kode dibawah, sebab terlihat jelas mana variabel yang mengurus method POST untuk nama, email, dan lainnya.
2. Penulisan fungsi yang baik
Fungsi yang baik memiliki beberapa syarat, diantaranya :
- Small! Function should be small and smaller.
- Do One Thing.
- Use Descriptive Names
- Have no side effects
3. Komentar yang efisien dan sesuai
Komentar tidak digunakan sebagai “penetralisir” kode yang kurang bagus. Jika memang masih ada kode yang masih kurang bagus, maka perlu diperbaiki kembali. Komentar hanya dituliskan untuk memberi penjelasan tambahan pada suatu bagian kode. Contoh penerapan yang kami lakukan adalah seperti berikut :
Pada gambar diatas terdapat komentar yang menandakan batas line mana saja yang berisikan kode untuk mengatur navbar pada website.
4. Layout Formatting
Formatting akan membantu kita menyusun kode program agar terlihat rapi. Contohnya seperti penggunaan whitespace yang baik, panjang maksimal sebuah line, penulisan antar blok kode, dan lainnya. Kita dapat menerapkan tool linter sesuai dengan bahasa pemograman yang digunakan. Pada program kami, kami menggunakan flake 8 untuk mengatur layout kami.
5. Don’t Repeat yourself
Kita perlu membuat kode dengan object dan data yang terstruktur. Salah satu cara untuk mengatasinya adalah dengan penerapan design pattern pada kode yang kita buat. Hindari adanya duplikasi kode pada program, sebisa mungkin gunakan kembali kode yang masih dapat digunakan.
6. Error Handling
Kita tetap perlu menerapkan error handling pada kode kita. Hal itu akan mengantisipasi setiap kemungkinan error yang akan muncul, serta memudahkan orang lain untuk memahami jenis error yang mereka terima. Terdapat beberapa poin yang perlu diperhatikan dalam membuat error handling, diantaranya :
- Use Exceptions Rather Than Return Codes
- Write Your Try-Catch-Finally Statement First
- Use Unchecked Exceptions
- Provide Context with Exceptions
- Define Exception Classes in Terms of a Caller’s Needs
- Define the Normal Flow
- Don’t Return Null. Don’t Pass Null.
Salah satu contoh penerapannya dalam kelompok kami adalah sebagai berikut
Jika terjadi kesalahan pada proses pengisian create jadwal dosen, maka aplikasi akan kembali ke halaman tersebut dan memberikan warning pada user.
Oke deh, sekian penjelasan mengenai clean code dari saya. Jadi untuk para pembaca jangan lupa untuk menerapkan clean code pada program yang kalian buat ya! Selain membantu code terlihat lebih “rapi” dan “bersih”, clean code juga akan membantu tim developer kalian untuk mengerti kode satu sama lain. Sampai jumpa pada cerita-cerita kami selanjutnya! Bye byee.
