Clean Code dalam SeLAW PPL 2019
Apa itu clean code? clean code adalah kode yang mudah untuk dimengerti dan mudah untuk diubah. Yang dimaksud dengan mudah dimengerti adalah mudah dibaca baik dibaca oleh pembuat kode ataupun orang lain. Selain itu kejelasan juga mengurangi kebutuhan untuk menduga dan kemungkinan kesalahpahaman.
Lalu apa saja komponen pada clean code dikatikan dengan apa yang sudah dikerjakan di SeLAW
Clean Code dalam SeLAW
Penamaan yang mempunyai makna jelas
Penamaan kelas “VoterUnvote” memiliki makna bahwa kelas ini adalah fitur “unvote” untuk role “voter”
Konsisten
Konsisten dalam gaya penamaan:
- kelas menggunakan PascalCase
- fungsi menggunakan snake_case
- variable menggunakan camelCase.
Pembuatan fungsi yang baik
Argumen yang diperlukan pada fungsi tidak lebih dari 3, jika lebih maka menggunakan kelas sebagai argumen. Panjang suatu fungsi yang berlebih dapat dipecah menjadi beberapa fungsi kecil yang memudahkan kita dalam debugging.
Tingkat kohesi yang tinggi
Suatu fungsi hanya memiliki 1 objektif sesuai dengan nama fungsi tersebut, sehingga mudah dipahami dan mudah di debug. Berlaku juga pada suatu kelas. Contohnya ada gambar diatas dimana setiap test case memiliki fungsinya masing-masing.
DRY (Don’t Repeat Yourself)
Kode yang baik adalah tidak mengulang kode yang sama secara manual. Implementasi pada proyek kali ini salah satunya terdapat dalam pembuatan test dimana sebeleum menjalankan serangkaian percobaan test kita menjalankan fungsi set-up terebih dahulu, sehingga tidak harus set-up berkali-kali untuk setiap butir test-case.
