“Membuat kode program itu mudah, yang sulit itu membuatnya dapat dibaca dan dikembangkan”. Saya lupa darimana kalimat diatas saya dengar tapi saya rasa kalimat tersebut telah menampar diri saya cukup keras. qqoosjflp.
Setelah berlalu lalang untuk mencari kitab suci tahu bagaimana cara membuat program yang tidak hanya dapat berjalan lancar, tetapi juga dapat dengan mudah dibaca dan dikembangan, akhirnya saya menemukan sebagian kecil ? faktor dari apa saja yang dapat meningkatkan kualitas kode program yang saya buat, terutama dalam bahasa pemrograman yang saya gunakan sehari – hari, Javascript.
Izinkan blog pertama ini saya mulai dengan membagikan pengetahuan saya tersebut, yaitu tentang bagaimana cara kita meningkatkan kualitas kode program untuk dapat dengan mudah dibaca dan dikembangkan, khususnya pada bahasa pemrograman Javascript.
Agar blog ini tidak terlalu panjang, saya akan membaginya menjadi beberapa bagian, dan ini merupakan bagian pertama : Menulis kode Javascript yang bersih - Variabel
1. Jelas
Walaupun memberi nama variabel itu cukup memakan waktu, percayalah itu akan memudahkan kita di masa yang akan datang 😊
BAD
let h; // hours
GOOD
let hours;
Jangan ragu – ragu membuat nama variabel yang panjang, karena penamaan nama variabel yang jelas akan sangat membantu kita untuk mengerti kode program di kemudian hari nanti.
2. Mudah Diucapkan
Usahakan juga menggunakan nama variabel yang mudah untuk diucap.
BAD
let yyyymmdd = moment().format('YYYY/MM/DD');
GOOD
let currentDate = moment().format('YYYY/MM/DD');
Bayangin kalau nama variabel kita yyyymmdd
, terus ada anggota tim nanyain variabel, jadi kerepotan sendiri kan nyebutnya ?
3. Hindari God Number
Angka yang hanya dimengerti tuhan. Waduh gimana tuh.
Tenang itu cuman sanggahan para programmer buat angka yang kurang jelas dari mana asal usulnya.
BAD
for (let I = 0; i <= 60; i++) {
// do something
}
GOOD
let minutesInHours = 60;
for (let i = 0; i <= minutesInHours; i++) {
// do something
}
4. Ekplisit (Avoid Mental Mapping)
Hindari menerjemahkan kata menjadi kata lain karena alasan kata tersebut sudah umum digunakan. Biasanya ini masih sering terjadi ketika berurusan dengan perulangan.
BAD
const fruits = ['Strawberry', 'Apple', 'Orange', 'Watermelon'];
fruits.map((e) => {
doSomeStuff();
});
GOOD
const fruits = ['Strawberry', 'Apple', 'Orange', 'Watermelon'];
fruits.map((fruit) => {
doSomeStuff();
});
5. Hindari penambahan kata yang tidak perlu
Hindari penamaan kata yang konteksnya sudah jelas.
Ini sering terjadi ketika memberikan nama pada properti class
atau object
.
BAD
const Car = {
carVendor: 'Honda',
carModel: 'Jazz',
carColor: 'white',
};
const paintCar = (car) => {
car.carColor = 'Blue';
};
GOOD
const Car = {
vendor: 'Honda',
model: 'Jazz',
color: 'white',
};
const paintCar = (car) => {
car.color = 'Blue';
};
6. Gunakan CAPITALIZE untuk penamaan variabel global berupa const
Ini akan membantu kita untuk dengan cepat membedakan mana tipe data yang berupa konstan ( tidak berubah ) dan yang hidup ( berubah )
BAD
let baseUrl = 'https://randomapi/';
GOOD
let BASE_URL = 'https://randomapi/';
7. Gunakan tipe data const
ketika nilai tidak akan pernah berubah
Selain untuk memaksimalkan tipe data yang ada di Javascript, ini juga berguna untuk mempermudah kita ketika membaca kembali kode program karena hanya dengan melihat sekilas saja kita bisa membedakan mana yang merupakan nilai tetap dan yang bukan.
BAD
let BASE_URL = 'https://randomapi/';
GOOD
const BASE_URL = 'https://randomapi/';
8. Gunakan sanggahan yang tepat untuk nilai boolean
Terkadang sangat membingungkan ketika terdapat nilai boolean
pada perulangan atau pengkondisian, mungkin salah satu faktornya karena kita tidak secara tepat memberikan nama pada variabel boolean
tersebut.
Gunakan sanggahan is
atau has
untuk memaksimalkan penulisan variabel bertipe boolean
BAD
if (vehicle) {
// do something
}
GOOD
if (isVehicle) {
// do something
}
Penutup
Itu tadi sedikit catatan saya mengenai bagaimana cara kita untuk dapat meningkatkan kualitas kode yang kita buat, khususnya pada variabel di Javascript. Semoga bisa bermanfaat.
Untuk catatan selanjutnya, will be added soon ya.
Top comments (2)
mantap!
ampun guru huhuuu