Kenal Lebih Lanjut sama Clean Code!
Ada banyak peraturan tentang proses pengembangan software pada perusahan-perusahaan teknologi, dan setiap itu dikembangkan untuk menyelesaikan masalah untuk membuat agar bisa dirawat. Ketika kamu mengembangkan sebuah projek sendiri yang kamu lakukan hanya ada dua : menulis kode kemudian push kode tersebut menggunakan semacam versi kontrol seperti git. Namun, mengembangkan fitur dengan pengembang lain dengan skala kode yang besar akan susah untuk diatur. Maka dari itu, setiap perusahaan membutuhkan sebuah peraturan untuk mengatur clean code ketika kita menjadi onboard engineer. Proses untuk melakukan clean code bisa dibagi menjadi 5 bagian :
Menentukan aturan -> Menulis kode -> Menggunakan Static Code Checker -> Mereview Kode -> Gabungkan
Programmer yang profesional tidak hanya mementingkan bagaimana software yang dibuatnya bisa berjalan, tapi juga harus memiliki semangat software craftmanship. Menurut Pete McBreen pada buku Software Craftmanship menjelaskan bahwa :
“ Menjadi seorang software developer yang baik melibatkan banyak aspek, tidak hanya sekedar belajar untuk menulis program. Pengembangan perangkat lunak adalah sebuah craft, menyatu dengan ilmu pengetahuan, teknik, matematika, ilmu bahasa, dan seni”
Dalam buku tersebut Pete McBreen berupaya mengumpulkan manifesto-manifesto untuk pengembangan perangkat lunak, yaitu :
- Tidak hanya membuat perangkat lunak, namun juga perangkat lunak yang dibuat dengan baik.
- Tidak hanya menanggapi perubahan, tetapi juga terus memberikan nilai tambah.
- Tidak hanya individualis dan interaksi, tetapi juga komunitas profesional.
- Tidak hanya bekerjasama dengan pelanggan, tetapi juga produktif.
Sesuai dari kaidah software craftmanship nomor satu, bahwa ketika ketika membuat perangkat lunak tidak hanya sekedar membuat saja namun perlu dibuat secara baik, secara kode dan berjalan dengan baik.
Untuk mengatakan bahwa aplikasi memenuhi syarat Clean Code, terdapat beberapa kriteria yaitu :
- Coupling Rendah
- Kohesi Tinggi
- Class-class kecil, jangan dibuat terlalu panjang
- DRY (Don’t Repeat Yourself), jangan mengulangi class atau fungsi yang sama dalam sebuah kode
- Nama yang sesuai
- Konsisten
- Tanpa Komentar, buatlah kode sejelas mungkin tanpa menggunakan komen dari fungsi dari class tersebut sudah dapat diketahui.
Berikut adalah contoh penerapan terkait clean code pada PHP :
- Penamaan Variable, Method, dan Class Harus Jelas
Hal yang paling umum dibuat pada saat mengembangkan sebuah aplikasi adalah nama dari variable yang dituliskan. Tuliskan nama variable secara jelas dengan pastinya harus sesuai dengan konteks. Kemudian pastikan bahwa kode yang kita tuliskan konsisten untuk seluruh source code yang akan kita buat nantinya.
Penamaan Variable, Method, dan Class yang jelas akan memudahkan pengembang dalam melakukan debugging.
- Penggunaan Seleksi Kondisi
Pada penggunaan seleksi kondisi terkadang juga membingungkan, tidak sedikit programmer yang menggunakan perintah ‘if’ banyak untuk membuat aturan seleksi kondisi. Sedangkan ada perintah ‘else-if’ yang ketika perintah ‘if’ tidak memenuhi aturan maka akan langsung dilemparkan ke aturan selanjutnya tanpa harus berganti perintah seleksi kondisi.
- Hapus Kode Program yang Tidak Digunakan
Banyak para pengembang juga mencoba-coba kode dan kemudian gagal, akhirnya kode tersebut di komen untuk berjaga-jaga jika kita menggunakannya lagi. Namun, pada akhirnya kita melupakan hal tersebut dan kode program tersebut tidak dihapus sampai aplikasi sudah berjalan.
Bayangkan jika ternyata kode yang dikomen ada lebih dari ratusan baris, ternyata malah hampir dari seluruh kode program tersebut adalah kode yang tidak terpakai. Tips terbaik adalah menghapus kode program tersebut, jika memang sekiranya kode program tersebut digunakan maka taruh kode tersebut pada file catatan.
- Dekomposisi Kode
Salah satu fungsi method adalah untuk modularize program, jadi ketika terdapat kode program yang memiliki jumlah baris yang besar maka perlu dilakukan dekomposisi kode dan dipisahkan berdasarkan fungsi dan jenis masing-masing.