Penggunaan Clean Code untuk Project yang Lebih Baik
Halo pembaca medium kami yang hebat dan keren, Saya Ryan, salah satu Hacker dari kelompok PDB+R, dalam tulisan kali ini saya akan membahas mengenai Clean Code.
Definisi
Clean Code atau dapat diartikan kode yang bersih, merupakan salah satu hal yang penting untuk membuat project secara berkelompok. Mengapa penting? Karena kode yang dibuat oleh seorang programmer belum tentu bisa dibaca oleh programmer lainnya. Hal ini akan menjadi sulit jika kode tidak dapat menjelaskan secara langsung mengenai program itu sendiri.
Konsep
Ada beberapa hal yang merupakan konsep dari Clean Code diantaranya adalah :
1. Komentar yang efisien
Kode yang baik bisa diterapkan dengan menggunakan komentar yang efisien, bahkan akan lebih bagus jika kita tidak menambahkan komentar. Karena kode yang kita buat seharusnya sudah readable tanpa kita perlu menambahkan penjelasan tambahan melalui komentar. Namun jika memerlukan komentar, terdapat hal-hal khusus yang bisa dibuat dalam komentar, diantaranya penjelasan tambahan dari fungsi tersebut dan penjelasan hak cipta dari kode tersebut.
2. Penamaan yang baik
Penamaan yang baik diperlukan pada nama variable, fungsi, atau penamaan aplikasi. Kita harus memastikan penamaan yang kita buat mengikuti aturan penamaan yang ditetapkan oleh bahasa pemrogramman atau framework yang sedang kita gunakan. Selain itu, nama variable juga harus bermakna.
3. Penulisan fungsi yang simple dan efektif
Fungsi yang kita buat harus fokus pada satu tujuan tertentu dan ditulis dalam kode baris yang tidak terlalu panjang. Hindari juga pembuatan fungsi yang memiliki side effect karena akan membuat orang lain yang akan mengembangkan kode kita kesulitan memahami behaviour dari fungsi tersebut.
4. Pengkodean Error dan Exception Handling
Kode yang baik adalah yang dilengkapi dengan error handling yang baik. Hal ini untuk mengantisipasi kemungkinan error yang bisa menghentikan program saat sedang running. Error handling yang baik akan membantu orang lain memahami permasalahan apa yang ia hadapi ketika mendapatkan error tersebut.
5. Don’t Repeat yourself
Hindari pembuatan kode duplikat agar kode yang kita buat tidak banyak karena duplikasi tersebut. Untuk mengatasi hal ini, kita bisa melakukan reuse terhadap kode yang akan digunakan kembali. Selain itu,juga bisa menggunakan editor yang telah dipasang plugin khusus untuk mendeteksi duplikasi kode pada program kita sehingga kita bisa mengantisipasi pembuatan kode duplikat secara tidak sengaja.
6. Layout Formatting
Formatting kode dapat mencangkup penggunaan whitespace yang baik dan keteraturan penulisan antar blok kode. Kita bisa menggunakan tool linter yang sesuai dengan bahasa pemograman yang sedang digunakan untuk membantu kita mengatur layout dari kode yang kita buat, sebagai contoh jika menggunakan python kita bisa menggunakan pylint atau flake 8.
Umumnya programmer bekerja dalam tim. Karena bekerja dalam tim, maka kode yang harus dibuat harus dipahami oleh semua anggota tim, agar anggota tim lain tahu bagaimana cara memakai kodingan tersebut. Karena hal ini, setiap programmer dianjurkan untuk menerapkan konsep dari Clean Code yang sudah dijelaskan diatas.
Implementasi Kelompok Kami
Kelompok kami sudah mengimplementasikan beberapa konsep dari clean code diantaranya penamaan yang baik, pengkodean error dan exception handling, don’t repeat yourself dan layout formatting.
Penamaan yang Baik
Dari code diatas, dapat dilihat bahwa penamaan fungsi sudah sesuai dengan isi dari fungsi yang dimaksud serta sudah sesuai dengan aturan penamaan untuk test pada django.
Pengkodean Error dan Exception Handling
Dari code diatas, dapat dilihat terdapat exception handling yang dilakukan pada salah satu method pada fitur CRUD_Data_Mahasiswa. Hal ini dilakukan agar programmer atau user ke-depannya akan tau error yang dimaksud.
Don’t Repeat Yourself
Dari code diatas, dapat dilihat bahwa pembuatan objek cukup sekali aja. Jika ingin menggunakan objek yang sama, kami hanya memanggil method pembuatan objek tersebut.
Layout Formatting
Untuk formatting kode, kelompok kami menggunakan tool linter yaitu flake 8. Tool ini digunakan untuk mengatur penggunaan whitespace yang baik dan mengatur penulisan antar blok kode. Tool ini berguna untuk mengatur layout kode yang kami buat.
Oke deh gan, sepertinya tulisan dari saya mengenai Clean Code segini dulu, semoga kalian ke-depannya semakin tertarik dengan tulisan dan kelompok kami :)