Tips simple untuk simple code: part 1. Hindari penggunaan singkatan.

Salah satu arsip tulisan lama yang tidak selesai karena sibuk. Kali ini kita mau bahas beberapa tips untuk kamu yang jadi programmer (yg ga pro pastinya) atau apalah bagaimana membuat kode yang kamu tulis menjadi lebih simple, lebih mudah di baca baik oleh kamu sendiri ataupun tim kerja kamu nanti. Tips pertama yang akan kita bahas adalah hindari penggunaan singkatan (No Abreviation).

Singkatan atau abreviation kadang hanya bisa dimengerti hanya oleh kamu (dan tuhan), jadi bisa disimpulkan jangan sampai dalam penulisan ribuan baris kode itu, kamu buat penamaan untuk class, function ataupun variable dengan singkatan-singkatan seperti misalnya ord untuk order, sdml untuk function sendmail dan lainnya. Untuk lebih jelasnya coba kita lihat contoh kode di bawah ini. Mana yang menurut kalian lebih mudah di mengerti?

//1 pakai singkatan
class Trnsltr{}

//2 tidak pakai singakatan
class Translator{}

Tidak ada yg salah dari kedua nama class tersebut, tapi tentu saja penamaan yang kedua lebih mudah di mengerti. Itu karena langsung menjelaskan apa yang akan dilakukan oleh class tersebut. Jika kalian masih menulis nama class seperti contoh no 1, segera ubah sekarang juga karena ga ada untungnya ya. Beberapa text editor juga akan lebih mudah mengindex nama class dan function yang memiliki arti real dibandingkan dengan singkatan kayak gitu. Selanjutnya kita ke contoh yang kedua dimana penulisan seperti di bawah ini sering dilakukan.

//sample looping
foreach($x in $persons){
	echo $x->name;
	echo $x->address;
	echo $x->phone;
}

Coba angkat tangan dulu siapa yang masih suka nulis looping dengan cara di atas? Saya aja sering banget lo nulis kayak gitu kok bro. Salah satu alasanya tentu lebih praktis kan? Terus suka-suka programmernya dong? Tapi coba kita lihat bentar bagaimana harusnya penulisan yang lebih baik dari contoh looping di atas.

foreach($person in $persons){
	echo $person->name;
	echo $person->address;
	echo $person->phone;
}

atau

foreach($girl in $persons){
	echo $girl>name;
	echo $girl>address;
	echo $girl>phone;
}

Lihat apa bedanya? Ya, sekali lagi tanpa singkatan. Walaupun hasilnya nanti sama saja, tapi dari penulisan contoh ke dua dan ketiga jauh lebih mudah dibaca dan punya makna. Jadi jelas apa object yang mau dijabarkan di dalam looping tersebut bukan hanya sekedar variable x, y, ataupun z.

Satu lagi, kalau misalnya ada banyak data tentang object tersebut misalnya lebih dari 5, dengan penamaan hanya dengan x atau y  kita suka lupa object apa itu sebenarnya yang mau kita jabarkan. Bayangin aja jika kamu punya ribuan baris code dengan hanya single character variable gitu maka udah pasti code kamu susah banget di ngertiin deh. Jadi coba cek deh source code project yang kamu buat, jika masih ada yang seperti di atas, segera ganti sekarang juga. 

Selanjutnya kita lihat contoh selanjutnya.

class UserRepository{
	function fetch($billingId){
}

$user = new UserRepository;
$user->fetch(2);

Coba perhatikan apa ada yg kurang baik dengan penulisan class di atas? Kayaknya ga ada kan? Tapi bagaimana kalau kita tulis kode kita seperti di bawah ini. Kita punya 2 pilihan penulisan.

class UserRepository{
	//pilihan 1
	function fetchUserByBillingId($billingId){
	}

	//pilihan 2
	function fetchByBillingId($Id){	
	}
}

$user = new UserRepository;
$user->fetchUserByBillingId(2);
$user->fetchByBillingId(2);

Sekarang kita punya 2 pilihan penamaan untuk fungsi tersebut. Jadi mana yang lebih baik dipakai? Untuk pilihan pertama menurut saya kurang baik juga karena tertalu verbose atau berlebihan tapi ga ttp ga salah ya, cuman kurang pas. Nah yang kedua cukup pas karena sesuai dengan tips kita kali ini yaitu tidak ada singkatan, tidak terlalu over atau verbose, dan yang jelas nama function tersebut mampu menjelaskan fungsinya dengan baik sehingga kamu atau programmer lainya yang akan melanjutkan kerja kamu tidak akan kebingungan nantinya.

Jadi kesimpulannya dan saran untuk tips pertama kali ini adalah:

  • Menggunakan nama function atau variable maximal 2 kata saja kalau bisa
  • Hindari single character name seperti x, y atau z
  • Usahakan pakai penamaan yang kamu pakai  mempunyai arti yang menjelaskan apa dan sesuai dengan responsibility-nya.
  • Terakhir adalah keep practicing. Menulis kode tanpa singkatan-singkatan merupakan hasil dari kebiasan kalian selama ini ngoding. Kadang-kadang kita merasa apa yg kita buat sudah benar jadi terus latihan dan review lagi code yang kamu buat untuk membuat kode kamu lebih rapi, simple dan keren gais.

Untuk tips yang kedua adalah : Tips simple untuk simple code: part 2. Hindari penggunaan Else.

Please follow and like us:

Hi, Saya Agus Yusida

Hello, perkenalkan saya Agus Yusida, seorang freelancer programmer, pernah membuat startup dan suka mencoba hal-hal baru. Jika ada pertanyaan bisa DM saya di IG @yusidajohn untuk fast respond. Jangan lupa like facebook ngide.net ya!

Related Article