Mengenal Clean Code
Apa itu Clean Code?
Clean code adalah kode di dalam pengembangan software dengan format yang benar dan disusun dengan baik sehingga programmer lain dapat dengan mudah membaca, memahami, dan memodifikasi kode tersebut. Alasan mengapa clean code harus diterapkan diantaranya adalah “kode dapat berkomunikasi dengan programmer lain”. Selain itu, clean code bermanfaat untuk menghemat waktu dan biaya saat melakukan maintenance sistem.
Apa yang terjadi jika clean code tidak diimplementasikan?
Ada beberapa “menyeramkan” hal yang akan terjadi jika dalam pembuatan sistem clean code tidak diperhatikan, diantaranya yang paling berpengaruh adalah banyaknya waktu yang terbuang oleh programmer lain yang melanjutkan kode kita karena kode yang kita buat tidak mengikuti standar penulisan kode yang baik. Selain itu, mereka yang melanjutkan kode kita juga akan menyita waktu kita dalam mengerjakan pekerjaan lain, karena mereka harus bertanya kepada kita tentang kode yang kita buat. Hal ini akan menjadikan 2 pekerjaan tertunda karena tidak diimplementasikannya clean code, di satu sisi ada yang bertanya tentang ketidakjelasan kode, di sisi lain pekerjaan tertunda karena harus menjelaskan kode yang tidak jelas tersebut.
Lalu, bagaimana implementasi Clean Code ?
Dari tadi kita berbicara tentang harusnya clean code diimplementasikan. Saatnya kita membahas pengimplementasian clean code. Ada setidaknya enam point tentang clean code yang dapat meningkatkan kualitas kode yang kita buat, diantaranya:
- Komentar yang efisiean : komentar ditulis hanya pada bagian kode yang membutuhkan penjelasan ekstra, bukan karena jeleknya kode.
Dalam fungsi tersebut komentar hanya ditulis dengan apa yang dibutuhkan agar memenuhi readable. Sesuai dengan komentar yang ada, fungsi tersebut akan melakukan filter data untuk nama mahasiswa yang sesuai.
- Penamaan yang baik : penamaan variable dan fungsi mengikuti acuan umum dan baku yang ditetapkan untuk suatu pemrograman atau framework tertentu.
Sesuai dengan best-practice yang ada untuk react js, pada saat melakukan import component, penamaan yang baik adalah dengan PascalCase. Berbeda dengan pada saat pembuatan variable/ instance, penamaan yang baik adalah dengan camelCase. Hal ini dilakukan karena praktek tersebut juga dilakukan oleh developer lain pada react js, ini akan memudahkan developer lain pada saat mengerjakan/melanjutkan project tersebut.
- Penulisan fungsi yang simpel dan efektif : setiap fungsi/method hanya melakukan satu hal.
Fungsi yang dibuat harus ditulis dengan simple dan sesuai dengan fungsionalitasnya. Tujuan dari fungsi ini adalah untuk melakukan filter / pencarian data berdasarkan nama mahasiswa sesuai dengan input yang diberikan dari event.
- Exception handling : antisipasi setiap kemungkinan exception dengan handling yang sesuai.
Pada saat melakukan HTTP Request, terkadang API yang diambil sedang terjadi busy karena underconstruction. Dengan demikian, penggunaan catch akan menghandle error sesuai dengan error apa yang sedang terjadi, selanjutnya akan ditampilkan menjadi suatu message yang readable pada front-end seperti pada gambar yang kedua.
- Don’t Repeat Yourself! (DRY) : tidak terdapat duplikasi kode dan program dibuat secara modular dan terstruktur rapi.
Dalam pembuatan test, pengaksesan component untuk mencari attribute data-test yang sesuai dilakukan secara berkali-kali, dengan demikian pembuatan fungsi akan membuat efisiensi dan tidak terjadi duplikasi code. Terlihat bahwa saat membuat variable lembagaComponent, tidak melakukan perulangan kode. Akan tetapi, melakukan reuse pada fungsi findByTestAttr untuk mencari attribute yang terkait.
- Layout formatting : menerapkan aturan formatting code, menerapkan tools yang sesuai dengan teknologi bahasa pemrograman yang digunakan
Keuntungan Menggunakan Clean Code
Clean code memberi keuntungan bukan untuk pengembangan software, diantaranya:
- Memahami kode lebih cepat. Cepat atau lambat kita akan menyadari kode yang anda tulis merupakan abstraksi rumit yang sulit untuk dipahami, begitu pula orang yang akan melanjutkan kode kita.
- Memudahkan debugging. Dengan penerapan clean code, kita dapat lebih mudah mencari bug.
- Memudahkan maintanance. Apabila kita ingin menambahkan fitur baru, refactor, migrasi ke tech stack lain, maka dengan clean code akan terasa lebih mudah dan nyaman.