Clean code

Dalam penulisan setiap code, ada aturan yang harus dilakukan agar kode tersebut mudah dibaca oleh developer lain maupun kita sendiri jika telah lama tidak melihat kode tersebut.

Kira — kira berikut merupakan aturan — aturan penggunaan cleancode :

• Meaningful Names

Dalam membuat nama sebuah variabel maupun fungsi, gunakan penamaan yang merepresentasikan isi dari variabel, fungsi atau kelas tersebut. Biasanya penamaan fungsi menggunakan kata kerja, sedangkan penamaan variabel menggunakan kata benda.

contoh penamaan variabel

Pada gambar diatas, digunakan penamaan variabel recipients sebagai variabel yang menyimpan pengambilan nama — nama recipients pada tabel User.

• One Function One Task

Dalam pembuatan sebuah fungsi, implementasikan prinsip satu task untuk satu fungsi pada setiap fungsi yang dibuat.

contoh satu fungsi satu task

Masih menggunakan nama yang sama, pada fungsi ini saya mengimplementasikan satu task saja yaitu mengambil nama — nama dengan query yang diberikan yaitu nama user.

• White Space is a Nice Space

Dalam menulis sebuah kode, tidak jarang kode tersebut banyak mengandung syntax sehingga sebuah line pada kode akan menjadi terlalu panjang sehingga kita harus menggesernya untuk melihat keseluruhan kode tersebut pada satu baris.

contoh whitespace

MASIH, menggunakan gambar yang sama, dalam kode tersebut terdapat penulisan kode yang panjang yaitu pada saat meng-assign variabel recipients. Penggunaan “enter” digunakan sebagai salah satu pengimplementasian cleancode.

• Comments for Clarification

Penulisan komentar akan sangat dibutuhkan apabila kode yang ditulis sulit dimengerti. Dalam penulisannya, sebuah komentar tidak boleh membuat kode terlihat berantakan. Gunakan kata-kata yang representativ untuk menjelaskan blok kode tertentu sehingga komentar yang digunakan efisien.

contoh komentar for clarification

Pada gambar diatas, saya menggunakan komentar dalam menandai apakah yang dilakukan line of code tersebut.

• Error Handling

Dalam menuliskan kode, jangan lupa untuk mengidentifikasi kemungkinan error/sesuatu yang tidak diinginkan pada kode kita.

• Don’t Repeat Yourself

Dalam penulisan sebuah kode, jangan lakukan penulisan fungsi secara berulang terus menerus. Gunakan atau buat sebuah fungsi secara modular dan terstruktur rapi lalu terapkan paradigma pemrograman Object Oriented.