Kode yang ‘Bersih’ dan Pemberian Nama

Di SIRCLO, kami berinisiatif untuk terus meningkatkan diri sebagai Engineers. Salah satu area yang kami sadari masih lemah ialah kualitas dalam pembuatan kode. Jadi, kami memulai klub buku secara internal tim di mana setiap dua minggu kami membaca dan berdiskusi tentang bagian tertentu dari buku terpilih.

Topik pertama yang kami pilih berasal dari dua bab dari buku Clean Code yang ditulis oleh Robert C. Martin, yaitu Clean Code dan Meaningful Names.

Anda mungkin berpikir: “Lho, kenapa harus pusing dengan ‘kebersihan’ kode? Itu kan hanya kode.”

Ada beberapa alasan yang diungkapkan dalam buku ini:

  1. Membaca dan memahami kode yang tidak ditulis dengan baik dapat membuang waktu.
  2. Perangkaian yang tidak diinginkan, jadi perubahan di satu bagian kode dapat mempengaruhi yang lainnya.
  3. Kemudian, hal tersebut membuat prosedur yang seharusnya sederhana menjadi kompleks.
  4. Dibutuhkan biaya tinggi untuk memelihara kode yang buruk sehingga dapat mengarah pada produktifitas yang rendah.

Dari dua bab dari buku di atas, kami mempelajari hal berikut:

Standardisasi skema penamaan

Berbasis kepada Pick One Word per Concept, hal tersebut juga perlu dilakukan dalam pemberian nama. Contohnya: get, fetch, and retrieve.

Menetapkan glosarium untuk istilah

Melanjutkan standardisasi sistem pemberian istilah, kita perlu memiliki referensi yang konsisten untuk digunakan oleh anggota tim lainnya. Misalnya, istilah import digunakan saat mengambil data dari API eksternal, sedangkan download hanya dipakai untuk kegiatan user seperti saat mengunduh sebuah dokumen.

Penamaan function harus mendeskripsikan pekerjaannya

Developer lain seharusnya dapat menggunakan function yang sudah dipakai tanpa perlu membaca logika di tingkatan bawahnya.

Peninjauan proses ekstra teliti oleh tim

Anggota tim lainnya perlu dilibatkan dalam menjaga standar kualitas kode agar terus konsisten dengan yang sudah ditetapkan.

Lebih baik terlalu bertele-tele daripada terlalu samar

Kami memahami bahwa nama yang pendek adalah ideal. Namun, lebih baik memiliki nama yang lebih panjang daripada memilih nama yang pendek tapi sulit dipahami.

Jangan terburu-buru dalam memilih nama

Sebagai developer, memperlakukan kualitas kode sambil lalu saja. Oleh karena itu, kita perlu mundur selangkah dan melihat kembali dampak dari kode yang kita buat.

Kesimpulan

Karena kita bekerja secara tim, kita perlu memiliki rasa empati yang lebih besar karena kode yang kita buat bukan hanya untuk diri sendiri tapi juga untuk digunakan dan dipelihara oleh sesama tim.