Definite

Digital · Expertise · Productivity

Kode Baik

Written by Dharma Saputra, 26 July 2016

Hidup sebagai seorang developer, membaca dan menulis code adalah kegiatan kita sehari-hari. Constant, variable, method, property, class tiap hari kita berhadapan dengan itu semua. Ketik, ketik, ketik. Dari satu baris jadi satu function, dari satu function jadi satu class, dari satu class jadi satu fitur. Tapi pernahkah terpikir, sudah baikkah kode yang kita buat? Kita bahas satu per satu yuk.

1. Easy to Read
Mengapa kode kita harus mudah di baca? Suatu hari kita sedang membuat fitur dari sebuah aplikasi. Semuanya berjalan lancar sampai aplikasinya di rilis ke production. Aman. Terus bisa pindah mengerjakan aplikasi lain. Tiba-tiba 3 bulan kemudian aplikasi awal yang tadi kita buat ada penambahan fitur. Buka file kode bingung, karena sudah lupa. Padahal itu kode buatan sendiri. Akhirnya kita membutuhkan waktu yang lebih lama, karena susahnya mempelajari lagi kode yang kita buat. Itu baru kode yang kita buat sendiri loh, bagaimana dengan kode yang di buat sama orang lain? Jadi bagaimana agar kode kita mudah di baca? Berikut tipsnya:

  • Beri nama variable dengan jelas. Sering membuat variable dengan nama $a, $b, $c, … dst? Tinggalkan. Namai variable dengan lebih jelas. Biar gak lupa.
  • Sama halnya juga dengan nama function, buat lebih jelas sesuai dengan apa yang saja yang di lakukan oleh function tersebut.
  • Saat sudah bekerja dengan team, sepakati bersama juga style apa yang di pakai untuk penamaan variable/function, snake_case, atau camelCase. Biar seragam.
  • Beri indentasi dan spasi yang baik, mungkin mirip seperti mengetik di Word.
  • Batasi jumlah karakter perbaris 80 – 120 karakter, jadi gak harus scroll-scroll ke kanan. Capek kan kalau udah scroll ke bawah, terus harus scroll ke kanan/kiri juga. Jadi kalau ngetik harus di hitung gitu? Gaak. Masing-masing editor udah ada settingannya kok. Kalau di SublimeText: Preferences -> Settings – User -> tambahkan “ ‘rulers’: [ 80 ], “
  • Beri keterangan/dokumentasi.
  • Rajin-rajin baca kode buatan developer di luar sana.
  • Oh iya, ikuti coding standard sesuai bahasa yang di pakai. Untuk bahasa PHP: http://www.php-fig.org/, ini standar seluruh dunia looh. Siapa tahu kode kamu akan di baca sama orang luar sana. Biar gak malu-maluin. :D. Untuk bahasa lain cari sendiri aja yah.

Kalau kata kata Om Bob:
“So if you want to go fast, if you want to get done quickly, if you want your code to be easy to write, make it easy to read.”, Robert C. Martin, dalam buku Clean Code: A Handbook of Agile Software Craftmanship.

2. Easy to Debug

Debugging adalah salah satu cara mengetahui ada masalah apa dengan kode yang kita buat. Debugging juga jadi salah satu cara kita mempelajari alur aplikasi. Semakin sulit di debug, semakin lama waktu yang di butuhkan untuk perbaikan. Bahkan bisa jadi setelah perbaikan malah muncul bug lain. Nah, membuat kode yang gampang di debug ini nih yang butuh banyak latihan. Yang dibawah ini singkat-singkatnya aja yaah:

  • Selalu buat kode yang gampang di baca, tipsnya udah ada di atas :p. Karena sebagian besar waktu yang kita lakukan dalam debugging adalah membaca kode.
  • Gunakan / pelajari Design Pattern. MVC, Factory, Singleton, Facade, dll. mempelajari topik-topik ini akan sangat membantu,
  • Terapkan SOLID (Single Responsiblilty, Open/Closed, Liskov Subtitution, Interface Segregation, Dependency Inversion) Principle.
  • Gunakan tool-tools yang membantu dalam debugging. Untuk PHP misalnya dengan Xdebug atau VarDumper dari component Symfony.

Nih gua kasih lagi quote dari Om Ariya Hidayat:
“Don’t code today what you can’t debug tomorow”, Ariya Hidayat, pembuat PhantomJs

Sudah tahu kan cara menulis kode yang baik. Happy Coding.

Freebies E-Book

Check out our free e-book on
easy ways to redesign your website
Download Now

Interested in what we do?

Let’s have a talk, and see how together we can take your brand to the next level.

Contact us




    Hi there!

    Need a partner for your brand’s digital endeavor?

    Contact Us
    Whatsappp Sharing