Clean Code: Bagaimana Cara Menerapkannya?
Sebelum masuk kedalam bagaimana cara menerapkan clean code, pertama saya akan menjelaskan apa yang dimaksud dengan clean code. Clean code adalah istilah untuk “code yang mudah dimengerti dan mudah untuk diubah”. Terdengar menarik bukan? Tapi mari kita coba memahami maksud dari kalimat “mudah di mengerti” tersebut yang bisa diartikan code yang dibuat mudah untuk dibaca baik dari pembuat code itu sendiri atau orang lain, baik secara flow jalannya program maupun method dan variabel yang ada di dalam program tersebut.
Dalam artikel ini saya akan menjelaskan bagaimana caranya menerapkan clean code seperti yang sering saya kerjakan sehari-hari sebagai back-end engineer di NetMonk, startup yang bergerak di network monitoring system.
“Any fool can write code that a computer can understand. Good programmers write code that humans can understand.” — Martin Fowler
Berdasarkan kalimat dari Martin Flower di atas, dapat diartikan bahwa orang bodoh mana pun bisa menulis code yang bisa dimengerti komputer. Programmer yang bagus menulis code yang dapat dimengerti manusia. Jadi bisa disimpulkan bahwa semua orang bisa menulis code tapi hanya beberapa yang bisa menulis code yang dapat dimengerti orang lain. Nah dari code yang dapat dimengerti itu, berlanjut ke code yang “mudah untuk diubah” ini bisa diartikan sebagai code yang mudah untuk dikembangkan, mudah untuk memperbaiki bug di dalam codebase-nya, dan mudah untuk di refactor ulang.
Sekarang Anda sudah mengerti apa itu clean code. Selanjutnya kenapa Anda harus menerapkan clean code ketika membuat program? Berikut beberapa alasannya:
1. Sebagai programer seringnya Anda akan bekerja sebagai team jadi kita harus memastikan code yang kita buat rapi dan mudah dibaca.
2. Dalam teamwork kita juga harus memastikan code yang dibuat tidak terlalu kompleks sehingga bisa lebih mudah dikembangkan dan di-refactor.
3. Programmer yang baik tentunya kita harus memberikan kualitas kode yang baik pula.
Bagaimana cara menerapkan clean code? Berikut ini saya berikan beberapa caranya yang bisa Anda ikuti.
1. Pemberian nama variable, method, dan class yang mudah dimengerti.
Ada beberapa ciri-ciri yang bisa diterapkan untuk penamaan yang baik yaitu:
- mudah dimengerti
function getData($name)Di atas adalah contoh penamaan yang sulit dimengerti karena kita tidak mengetahui data apa yang akan diambil.
function getDataCustomer($name) Berikutnya ini lebih baik karena lebih mudah dimengerti yaitu untuk mengambil data customer berdasarkan parameter “$name”
- mudah dibaca
Bisa dilihat dari penamaan variabel dibawah bahwa pada penamaan variabel yang kedua lebih enak dibaca dibandingkan yang pertama.
$nm_customer = "try satria"
$customer_name = "Try Satria"- Berikan komentar atau tidak memberikan komentar
Ada beberapa kode yang harus diberikan komentar jika kode tersebut mungkin sulit untuk dimengerti dan butuh informasi tambahan untuk membaca kode tersebut. Berikut adalah contoh kode yang harus memakai komentar.
//for check email format validation
if (preg_match("[\w-]+@([\w-]+\.)+[\w-]+", $email)) {}Jika sudah jelas maksud dan arti dari kode tersebut maka tidak perlu diberikan komentar tambahan. Berikut adalah contoh kode yang tidak perlu memakai komentar.
if (isCorrectEmailFormat($email)) {- Consistent
Jika dalam sebuah aplikasi ada beberapa fungsi yang melakukan sebuah konsep yang sama dalam melakukan tugasnya, maka gunakanlah penamaan yang seragam dan tidak bercampur sehingga lebih rapi. Sebagai contoh fungsi dibawah, bukankah lebih baik jika hanya mengunakan salah satu dari penamaan? Misalnya jika menggunakan search sebagai konsep dari fungsi pencarian maka untuk fungsi pencarian yang lain juga memakai search
function findDataCustomer()
function searchDataUser()- Ikuti standar dan peraturan
beda tempat kerja maka akan beda juga standar dan peraturannya, jadi kamu juga harus mengikuti aturan-aturan yang telah ditetapkan.
2. keep it so simple
Code yang baik adalah code yang simple. Mungkin banyak diantara kita yang beranggapan bahwa sebuah function yang bisa melakukan apa saja itu baik sehingga tidak perlu repot lagi untuk membuat function-function yang lain. Sebagai contoh seperti code di bawah ini :
Bisa dilihat dari fungsi di atas ini misalnya sebuah fungsi yang bernama delete bisa melakukan delete user, delete customer, dan delete transaction sekaligus. Ini adalah contoh yang kurang baik karena function yang baik adalah function yang melakukan satu tugas dalam pengerjaannya.
Nah… jika kita pisahkan fungsi delete menjadi fungsi delete yang spesifik berdasarkan tabelnya masing-masing seperti di atas, bukan kah menjadi lebih enak dibaca dan lebih enak jika ingin melakukan debuggingnya, bukan? Selain itu jangan gunakan terlalu banyak parameter ke dalam fungsi. Setidaknya 3 parameter sudah cukup.
3. DRY (dont repeat yourself)
Dalam konsep dont repeat yourself yaitu tidak mengulang code yang sama, mungkin diantara kita banyak yang melakukan copy paste code sehingga membuat terjadi duplikasi code. Maka dari itu, untuk menghindarinya sebaiknya dibuatkan function atau class yang bisa menggantikannya.
Dari contoh di atas mungkin terlihat seperti tidak ada yang salah, tidak terlihat seperti duplikasi kode, dan juga secara flow kode juga terlihat baik. Namun dalam konsep DRY sendiri, duplikasi bukan hanya menyangkut soal kode yang telihat sama tetapi juga menyangkut dengan mengekspresikan kode yang sama di dua tempat yang berbeda, mungkin dengan dua cara yang sama sekali berbeda. Misalnya saya mengubah kode seperti di bawah ini. Terlihat lebih baik, bukan?
4. Formatting code yang baik
Berikut adalah beberapa tips formatting yang membuat code Anda lebih mudah buat dibaca
- 80 karakter code perbaris
Standar panjang code perbaris adalah 80 tapi bisa juga lebih dan itu tergantung dari mana tempat Anda bekerja. Hal ini karena perusahaan memiliki standar yang berbeda. Mungkin Anda bertanya-tanya kenapa panjang karakternya harus 80 tidak 100 atau 120? Karena panjang karakter kode ini adalah standar pengkodean umum yang merupakan hasil dari format punched card, kartu Hollerith, atau kartu IBM pada tahun 1928 yang berjumlah 80 kolom.
Berikut ini adalah contoh formatting code yang salah karena terlalu panjang sehingga untuk membacanya sedikit lebih sulit.
Dan jika kita rapikan seperti dibawah ini.
- Kode-kode yang harus berdekatan
Usahakan kode yang saling berhubungan dibuat saling berdekatan sebagai contoh variabel dengan penggunanya, fungsi dengan yang memanggil fungsi itu, sehingga kita tidak perlu lompat-lompat jauh dalam membacanya. - Identasi pada kode
Perhatikan juga identasi pada kode jangan sampai kode jadi membuat salah paham karena identasi untuk masalah identasi Anda bisa menggunakan prettier atau formatter untuk membuat kode anda menjadi lebih rapi dan indah.
Kesimpulan
Dari penjelasan di atas, dapat disimpulkan bahwa dengan menerapkan clean code akan membuat kode Anda menjadi lebih berkualitas, rapi, dan mudah dikembangkan.
Referensi :
- https://thevaluable.dev/dry-principle-cost-benefit-example/
- https://hackernoon.com/how-to-write-clean-code-d557d998bb08
Martin, Robert C., editor. Clean Code: A Handbook of Agile Software Craftsmanship. Prentice Hall, 2009. - Catalog of Refactorings. https://refactoring.com/catalog/index.html and accessed 26 March 2019.
- “Code Refactoring.” Wikipedia, 15 Mar. 2019. https://en.wikipedia.org/w/index.php?title=Code_refactoring&oldid=887853856
- Technical Debt. https://refactoring.guru/refactoring/technical-debt and accessed 26 March 2019.
- AHA Programming. https://kentcdodds.com//blog/aha-programming and accessed 26 March 2019.
- WTFs/m — OSnews. https://www.osnews.com/story/19266/wtfsm/ and accessed 26 March 2019
- Code Refactoring (Software Gardening — Pruning) | DotNetCurry. https://www.dotnetcurry.com/software-gardening/1105/code-refactoring and accessed 26 March 2019
