Clean code

Code yang kita tulis akan merepresentasikan apa yang kita pikirkan. Semakin code mudah dibaca, semakin mudah untuk dikembangkan.

Di dunia software development hampir 80 persen pekerjaan kita adalah maintenance code yg sudah dikerjakan. Jika software terlalu banyak bad code, hal ini tentu akan menyulitkan pengembangan product bahkan mengambil waktu programmer karena effort yang dikeluarkan menjadi lebih banyak sehingga produktifitas tergangu.

Saya ingin membuat sebuah tulisan berseri yang saya ambil dari buku Clean Code, bagaimana prinsip prinsip dalam penulisan code yang bagus.

Meaningful Names

memberi nama adalah pekerjaan sehari hari para programmer, mereka harus memberi nama variable, method, class dan source file project yang dikerjakan. Pemberian nama yang bagus mungkin membutuhkan waktu, tapi hal tersebut akan menghemat banyak dari apa yg sudah dikorbankan.

Get Abi Wardani’s stories in your inbox

Join Medium for free to get updates from this writer.

Remember me for faster sign in

Penamaan variable, method atau class, sebisa mungkin menjawab pertanyaan kenapa mereka harus ada, apa gunanya mereka dan apa tujuan mereka. Sehingga programmer yang membaca tidak akan kesulitan untuk memahami maksud dari code tersebut.

int d; //elapsed times in day

d tidak memberikan arti apapun, cobalah memberikan nama seperti dibawah ini

int elapsedTimeInDays;
int daysSinceCreation;
int daysSinceModification;
int fileAgeInDays;

Class Name

Pemberian nama class dan object harus menggunakan kata benda, dan sebaiknya hindari penggunaan kata kerja. Contoh pemberian nama class yang benar, Customer, User, Account dll.

Method Name

Method name harus menggunakan kata kerja, seperti postPayment(), deletePage(), save(). Accessors, mutators dan predicates harus diberi nama dengan diberi prefix get, set dan is (merujuk pada javabean standard).

string name = employee.getName(); customer.setName("mike"); if (paycheck.isPosted())

Disarankan juga lebih baik menggunakan static method dengan nama yg mendeskripsikan argumentnya.

Complex fulcrumPoint = Complex.FromRealNumber(23.0);

Hal ini lebih baik daripada kita hanya membuat seperti ini

Complex fulcrumPoint = new Complex(23.0);

Clarity is king

Kita tidak bisa memaksa programmer lain untuk langsung mengetahui tujuan dari pemberian nama variable yang amat singkat. misalnya penamaan variable e untuk menampung nilai dari sebuah error. Bisa jadi di tim programmer lain e adalah sebuah nama yg digunakan untuk penjumlahan, bahkan merupakan sebuah counter di dalam looping.

Penggunaan variable yg tidak jelas maksud dan tujuannya. Hanya akan menghambat dan memperlambat.

Final Words

Hal yang paling sulit memang memberikan nama yang informatif, hal ini merupakan teknikal isu yang paling mendasar. Tapi dengan membuat code bisa dibaca selayaknya membaca cerita atau puisi. Setidaknya kita memudahkan hidup programmer lain yg bisa jadi diam2 terimakasih karena membuat code yang indah