Clean Code : The art of software craftsmanship (Part 1)

“You are reading this book for two reasons. First, you are a programmer. Second, you want to be a better programmer.” — Robert C Martin Series

Code yang buruk dan berantakan menjadi suatu halangan besar untuk suatu tim programmer dalam bekerja. Produktivitas terhambat hanya untuk mengerti code dari satu orang dengan orang lainnya. Lalu bagaimana cara kita untuk membuat code yang kita buat baik? The Art of Clean Code?

Clean code is simple and direct. Clean code reads like well-written prose. Clean code never obscures the designer’s intent but rather is full of crisp abstractions and straightforward lines of control. — Grady Booch, author of Object Oriented Analysis and Design with Applications

Berikut merupakan proses dari para programmer yang baik dalam menuliskan kode mereka, trik, teknik dan tools yang mereka gunakan.

Nama yang bermakna

• Gunakan nama yang relevan. Nama dari variabel, fungsi maupun class haruslah dapat menjawab pertanyaan besar seperti mengapa dia ada, apa kegunaanya dan bagaimana dia digunakkan.
• Hindari kesalahan informasi. Hindari menggunakan nama yang memiliki arti yang banyak. Contohnya : dataList, nama baik digunakkan jika stuktur data yang digunakan benar-benar sebuah list. Jika stuktur bukan list gantilah nama menjadi kumpulanData. Contoh lainnya seperti menggunakan l dan O sebagai nama, karena dapat menyebabkan kesalahan informasi dikarenakan miripnya dengan 1 dan 0
• Buatlah perbedaan yang bermakna. Buatlah nama variable yang memiliki perbedaan tetapi masih dalam satu scope, nama yang berbeda tapi bermakna. Hindari menggunakan nama yang number series seperti (a1, a2, a3, …. aN) dan memiliki noise seperti pembeda yang tidak berarti (produkInfo — produkData), penggunaan kata depan yang tidak diperlukan (aData, theProduct) ataupun variable yang memiliki nama stuktur data yang tidak diperlukan (nameString).
• Gunakan nama yang mudah di ucapkan. Hindari menggunakan nama yang sulit diucapkan karena akan menyulitkan untuk berdiskusi dengan programmer lain maupun mudah terjadi kesalahan, hindari nama seperti : genymdhms (generation date, year, month, day, hour, minute,
  and second).
• Gunakan nama yang mudah untuk dicari. Nama yang hanya memiliki satu karakter dan konstan susah untuk dicari dalam suatu berkas kode. Nama yang memiliki hanya satu karakter hanya baik digunakkan sebagai variabel lokal
• Hindari Encoding
• Hindari mental mapping