Clean Code – Naming Part II

Lanjutan dari Clean Code – Naming Part I

Mudah dilafalkan

Gunakanlah penamaan yang mudah untuk dilafalkan sehingga memudahkan kita mendiskusikannya dengan teman kerja secara verbal. Contoh penamaan yang tidak baik seperti di bawah ini.

public class DtPrsn
        {
            public int DtKy { get; set; }
            public string FrstNm { get; set; }
            public string LstNm { get; set; }
            public DateTime DtoBrth { get; set; }
        }

Bandingkan jika diubah menjadi seperti ini.

public class Person
        {
            public int Id { get; set; }
            public string FirstName { get; set; }
            public string LastName { get; set; }
            public DateTime DateOfBirth { get; set; }
        }

Mudah dicari

Jika kode program yang kita tulis sudah sangat banyak, tentulah akan semakin memakan waktu untuk mencari variable tertentu yang ingin kita modifikasi nilainya.

if (person.Gender == 0)

Jika kita menulisnya secara hardcode seperti di potongan kode di atas, maka pada saat kita ingin memodifikasi nilai Gender untuk Female menjadi 1 dan kondisi tersebut sudah dipanggil diberbagai tempat  sehingga akan sangat berisiko jika kita melakukan replace 0 menjadi 1. Karena bisa jadi beberapa enum menggunakan nilai 0 juga untuk membernya. Buatlah dalam bentuk enum atau konstanta.

if (person.Gender == (int)Gender.Female)

Penamaan Class and Method

Penamaan class haruslah mengandung kata benda (noun) seperti Customer, Account, hindari penamaan seperti Calculate, Processor. Sedangkan penamaan method harusnya mengandung kata kerja (verb)  dan Keyword seperti SaveCustomer, DeletePage, PostPayment.

Semakin pendek penamaan kita, selama itu jelas dan tidak membingungkan adalah semakin bagus. Tapi jangan sampai menimbulkan keambiguan. Contoh, Address adalah contoh yang tepat penamaan sebuah object (instance dari class) tapi bisa tidak begitu bagus sebagai nama class jika kita ingin membedakannya dengan MAC Address, Port Address. Nah, disini kita bisa memilih penamaan  menjadi PostalAddress.

Iklan

Tinggalkan Balasan

Isikan data di bawah atau klik salah satu ikon untuk log in:

Logo WordPress.com

You are commenting using your WordPress.com account. Logout /  Ubah )

Foto Google

You are commenting using your Google account. Logout /  Ubah )

Gambar Twitter

You are commenting using your Twitter account. Logout /  Ubah )

Foto Facebook

You are commenting using your Facebook account. Logout /  Ubah )

Connecting to %s