Clean Code

Berikut beberapa kesalahan yang sering ditemukan pada saat code review. Ini ditulis dengan harapan programmer dapat aware lebih awal dan mempersingkat waktu code review

Ultimate Purpose

Tujuan akhir dari clean code adalah agar code dapat dengan mudah dan cepat untuk:

1. Memahami apa maksud dari suatu code

2. Mengubah/memodifikasi code tersebut

Kesalahan yang Sering Ditemukan

1) Meaningful Names

Gunakan nama yang memenuhi kriteria ini untuk variabel, fungsi, kelas, file, dll:

1. Mengungkapkan intensi tanpa perlu penjelasan lebih lanjut

2. Menghindari kesalahpahaman

Contoh kurang baik:

const dateStart = moment(start_date).startOf('day')
const isSameDate = dateStart.isSame(new Date(), 'day')

if ((status === 0) && (isSameDate)) {
  this.btnDisableDate = false
}

Contoh lebih baik:

const SurveyStatus = Object.freeze({
    DRAFT: 0,
    ACTIVE: 10
});
const isStartedToday = dateStart.isSame(new Date(), 'day')

// jika status sama dengan draft dan tanggal mulai sama dengan hari ini
if ((status === SurveyStatus.DRAFT && isStartedToday)) {
  this.btnDisableDate = false
}

Perhatikan bahwa:

1. Dengan mendefinisikan nilai konstan sebagai variabel seperti status === SurveyStatus.DRAFT lebih mudah dipahami ketimbang status === 0.

2. Penamaan variabel isStartedToday lebih jelas intensinya ketimbang isSameDate.