Intern Wellcode.io - Cara mudah membuat kode yang bersih
Jadi software engineer bukan berarti gabisa sukses berbisnis loh, join dulu ke pinterusaha.ai
Part I
- Penggunaan nama yang bermakna
Yang bermaksud bahwa dalam kode yang bersih memnentukan
nama yang baik untuk digunakan sebagai fungsi, variabel, method dan
yang lainnya membutuhkan waktu yang cukup lama tapi efisien di
kemudian harinya. Alasannya adalah karna kita ingin kode kita bisa
dibaca dan dimengerti oleh programmer lain. Dan tentunya manfaat
untuk kita sendiri adalah saat kita meninggalkan kode itu beberapa hari
kemudian kita masih dapat membacanya tanpa memerlukan waktu
yang lama. Dalam penggunaan nama pun kita harus spesifik dalam
menentukannya dengan indicator apa alas an menggunakan nama
tersebut, untuk apa kita gunakan dan apa fungsinya.
Contoh:
Int d; // elapsed time in days
Ini tidak akan berefek apapun karna d tidak memiliki nama, dan
menggunakan comment dalam maksud penamaannya. Kita harus
memberi nama yang benar-benar spesifik apa yang menjadi ukuran
dana unita yang menjadi ukuran.
Lebih baik seperti dibawah ini:
Int elapsedTimeInDay;
Hindari menggunakan ejaan yang tidak konsisten. Contoh
sesungguhnya dari nama-nama yang disinformative adalah
penggunaan lower-case L atau upper-case O sebagai nama variable,
khususnya kombinasi. Masalahnya, tentu saja mereka terlihat hamper
keseluruhan mirip konstanta 1 dan 0.
Int a = l;
If ( 0 == l )
A = 01;
Else L = 01;
Pada kasus tersebut author disarankan menggunakan huruf yang
berbeda jadi perbedaannya bisa lebih jelas
- Fungsi
Dalam membuat fungsi hal penting yang harus diperhatikan
adalah jangan membuat fungsi dalam satu baris lebih dari 150 karakter
dan lebih dari 100 baris. Setidaknya buat satu fungsi tidak lebih dari 20
baris (tidak melebihi layar). Memasukkan level fungsi tidak boleh lebih
besar dari satu atau dua level, yang berarti bahwa blok dengan
statement if, else, while dan lainnya seharusnya memiliki panjang satu
baris saja. Saran berikut sudah ada selama 30 tahun lamanya:
“FUNCTION SHOULD DO ONE THING. THEY SHOULD DO IT WELL. THEY
SHOULD DO IT ONLY”
Yang berarti bahwa fungsi seharusnya benar-benar hanya
melakukan satu hal saja yang harus dilakukan dengan sangat baik.
The Stepdown Rule, membaca kodingan dari arah atas ke bawah.
Tentu menjadi kesulitan bagi programmer belajar mengikuti aturan ini
dan menulis fungsi-fungsi tetap menjadi single level dari abstraksi.
Mempelajari trik ini sangat penting. Karna ini kunci untuk menjaga
fungsi tetap pendek dan hanya melakukan satu hal saja.
Wellcode.io Team
Leading high-tech Indonesia Startup Digital - which serves the community with revolutionary products, system development, and information technology infrastructure