Baik setelah sebelumnya kita telah mempeljari mengenai Pengertian Clean Code, Prinsip Clean Code serta Manfaat Clean Code, pada artikel kali ini KonsepKoding akan berbagi informasi menganai bagaimana cara menulis kode yang Clean Code dan mudah untuk dipahami dan maintaince. Di tutorial ini akan di tunjukan menganai penamaan kode yang harus dihindari dan bagus untuk diikuti.


Penulisan Variable Kode Yang Clean

Nama variabel, fungsi, atau kelas, harus menjawab semua pertanyaan besar. Itu harus memberi tahu Anda mengapa itu ada, apa fungsinya, dan bagaimana ia digunakan. Jika suatu nama memerlukan komentar, maka nama tersebut tidak mengungkapkan maksudnya.

Contoh kasus

const i = 12. // don't

VS

const totalProduct = 12 //do
Dari variables di atas kita tidak langsung tahu dari nama variable pertama, karena hanya menggunakan nama i , dan pada variables kedua pasti kita langsung tahu bahwa angka 12 adalah value dari banyaknya produk

Penulisan Method Kode Yang Clean

Method harus memiliki nama kata kerja atau frasa kata kerja seperti postPayment, deletePage, atau simpan. Ketika konstruktor kelebihan beban, gunakan metode pabrik statis dengan nama yang menggambarkan argumen.

Contoh kasus

aData(a, b) {
 return a + b. // don't
}

VS

addingTotalNumber (fisrtNumber, secondNumber){
 return firstNumber + secondNumber // do
} 
Dari kode di atas jika sewaktu waktu  kita melakukan search pada file kode kita dengan match maka kode tersebut akan mudah untuk di temukan.


Penulisan Function Kode Yang Clean

Aturan fungsi pertama adalah mereka harus kecil. Aturan fungsi kedua adalah mereka harus lebih kecil dari itu, jadi pastikan anda membuat function yang hanya melakukan satu hal saya, dan untuk parameternya jangan samapai lebih dari 4, 

Contoh kasus

function  addData (data1, data2, data3, data4, data5, data6) {
  return some many code.  //don't
}

VS

function addingProductData (currentData) {
 retrun previousData() + currentData. // do
}

Penulisan Class Kode Yang Clean 

Kelas dan objek harus memiliki nama frasa kata benda atau kata benda seperti Pelanggan, WikiPage, Akun, dan AddressParser. Hindari kata-kata seperti Manajer, Pemroses, Data, atau Info atas nama kelas. Nama kelas tidak harus berupa kata kerja. Jadi aturan penamaan Class tidak boleh menggunakan nama kerja.


Contoh kasus

class Data Extends Component {
  return some code //  don't}

VS

class Cus0123 Extends Component {
  retrun some code  // don't}

VS 

class CustomerScreen Extends Compnent {
return some code  // do}

Dari kode di atas, penamaan kelas yang paling clean adalah urutan ketiga, karena tidak menggunakan nama kata kerja, tidak menggunakan nama yang ambigu dan menggunakan nama yang jelas dan mudah untuk di pahami.

Sekian artikel dan penjelasan mengenai penulisan kode yang clean atau Clean Code, semoga artikel Clean Code ini dapat bermanafaat dan membantu kamu yang sedang mencoba menerapkan Clean Code pada kode kamu saat ini.


Baca Artikel Clean Code Lainnya: