Apa Yang Dibahas di Buku Clean Code Chapter Kedua ?

Penamaan yang mencerminkan maksud dan tujuan

Penamaan yang baik di dalam code itu sangat penting. Kenapa sangat penting? Karena pemilihan nama yang baik untuk function, class, ataupun variable akan membuat code yang kita bikin menjadi mudah dibaca dan dipahami oleh programmer lain. Dalam membuat penamaan ini sering kali menyita waktu, namun menurut saya, hal tersebut sangat worthed. Saat akan membuat penamaan variable misalnya, coba terlebih dahulu pikirkan tentang jawaban dari pertanyaan ini: “kenapa dia ada?”, “apa yang bisa dia tersebut lakukan?”, “bagaimana dia digunakan?” — dia disini adalah function, class, ataupun variable. Dan juga variable itu tidak perlu disertai comment, jika ditambahkan comment, berarti si nama variable tersebut belum menjawab tiga pertanyaan itu.

`int total; //ini adalah total dari keseluruhan nilai transaksi per hari`

Contoh diatas adalah penamaan variable yang tidak baik, dan jika variable tersebut dipanggil di baris-baris berikutnya, si programmer akan bingung, “ini variable total maksudnya total apa?”, maka si programmer akan kembali ke baris yang ada comment-nya. Harusnya lebih baik seperti ini:

`int totalTransaksiPerHari;`

Penamaan diatas lebih jelas dan lebih mudah dimengerti, dan tanpa perlu ditambahkan comment. Dengan sekali lihat saja programmer akan langsung paham maksud dan tujuan si variable. Code yang sangat simple akan menjadi sulit untuk dipahami jika kita membuat penamaan variable yang buruk.

Hindari memberikan informasi yang salah

Dalam hal ini jangan membuat nama untuk variable dengan singkatan, karena singkatan bisa menimbulkan arti yang banyak. Selain itu adalah jangan membuat nama variable yang tidak mencerminkan isinya, contohnya `accountList`, tapi pada nyatanya variable tersebut diisi oleh `string`, yang benar harusnya diisi oleh `Array` atau `List`.

Selain itu jangan membuat variable yang satu dengan lainnya nampak tidak ada perbedaan. Misalnya membuat variable dengan nama `total`, membuat lagi satu variable dengan nama `total2`, karena variable `total` sudah ada. Nah ini tidak baik. Harusnya bikin nama variable dengan nama `totalTransaksiPerHari` dan `totalTransaksiPerBulan`. Nah ini lebih baik karena programmer akan langsung paham variable ini berisi informasi apa.

Gunakan penamaan yang mudah diucapkan

Kenapa harus mudah diucapkan? Ya karena sudah pasti saat kita melakukan diskusi dengan sesama programmer, kita akan ucapkan si variable tersebut ditengah-tengah obrolan kita. Misal kita membuat variable seperti ini:

`int jmlBrg;`
`int hrgSatuan;`
`int jmlTotal;`

Lalu kita mengobrol dengan rekan sesama programmer seperti ini: “Hey bro ini si je em el total apakah sudah benar tipe datanya integer? Karena bisa jadi kan si je em el be er ge diisi oleh nilai desimal, dan kalau dikalikan dengan ha er ge satuan akan menghasilkan desimal?”. Tidak lucu kan kalau kita mengorbrol dengan cara seperti itu dan juga sangat aneh dan tidak mudah dipahami. Maka lebih baik variable tersebut menjadi seperti ini:

`int jumlahBarang;`
`int hargaSatuan;`
`int jumlahTotal;`

Coba sekarang ganti percakapan diatas setelah penamaan variable-nya diubah seperti diatas. Lebih terdengar enak dan mudah dipahami bukan?

Gunakan nama yang searchable

Tujuannya supaya kita bisa mencari atau mem-filter variable tersebut dengan mudah, saat kita ingin mengetahui si variable tersebut digunakan dimana saja. Misalnya kita membuat variable dengan nama `reg`, lalu saat melihat hasil pencarian maka yang muncul bisa saja `registerNumber`, `isRegular` atau `userRegister`. Jadi lebih baik gunakan penamaan yang sangat jelas, gunakan kombinasi huruf yg lebih banyak supaya saat melakukan pencarian, akan mudah didapatkan dari hasil pencariannya.

Standar penamaan untuk class dan method

Untuk class atau object harus menggunakan kata benda, contohnya `Person`, `Customer`, `Account`, dan `Address`. Jangan menggunakan kata kerja saat membuat nama class.

Lain halnya dengan method, untuk method ini harus menggunakan kata kerja, contohnya `deletePage`, `saveTransaction`, `countSummary`, dan `postArticle`. Kenapa kata kerja? Karena method ini bertugas untuk melakukan atau melaksanakan sesuatu.

Selain hal-hal itu, gunakan juga penamaan yang tidak berlebihan atau bisa dibilang lebay. Contohnya menggunakan nama `killPage` padahal maksudnya itu adalah menghapus page, jadi lebih baik gunakan saja `deletePage`, maka akan lebih mudah dipahami.

Untuk method, gunakan satu kata untuk setiap konsep, contohnya kita ingin membuat method yang berfungsi untuk mengambil data dari database dan mengambil data dari form yang di-input oleh user. Untuk penamaannya mungkin kita akan berpikir seperti ini: `getDataFromDatabase` dan `retrieveDataFromUserInput`. Sekilas nampak tidak ada yang salah, tapi kalau kita perhatikan lebih detail disitu ada kata get dan retrieve, yang memang mempunyai tujuan yaitu mendapatkan. Maka lebih baik kita pilih salah satu, mau pakai get atau retrieve saja.

Memang seperti yang sudah saya singgung bahwa membuat penamaan yang baik itu membutuhkan waktu, karena mempertimbangkan kaidah-kaidah seperti yang sudah jelaskan diatas dan juga harus mengerti seluk beluk sistem yang akan kita bikin. Namun jika kita sudah terbiasa melakukannya, hal tersebut tidak akan menyita waktu lagi. Seperti kata pepatah, bisa karena terbiasa.

Happy coding!