Cara menerapkan clean code

 

Clean code

• Penamaan yang bermakna

Salah satu penerapan Clean Code yang paling mudah adalah dengan menamakan variabel, fungsi, kelas, dan sebagainya. Sejelas mungkin sesuai dengan fungsinya. Seperti yang kita ketahui, tujuan Clean Code adalah untuk membantu orang lain memahami kode kita. Oleh karena itu, penting bagi kita untuk memilih nama yang bermakna, bukannya nama acak atau asal.

• Aturan Penamaan

Setiap bahasa pemrograman biasanya memiliki aturan penamaan atau naming convention nya tersendiri. Naming convention inilah yang biasa kita kenal dengan camelCase, UpperCamelCase, snake_case, dan sebagainya.

Gunakan naming convention yang sudah ditetapkan secara konsisten sepanjang kode program kita. Ingat juga bahwa variabel, fungsi, dan kelas biasanya memiliki naming convention yang berbeda pula.

• Penggunaan Fungsi

Dalam membuat suatu fungsi, penting bagi kita untuk memastikan bahwa fungsi yang kita buat betul-betul fokus melakukan suatu task spesifik sesuai dengan namanya. Dalam penerapan Clean Code, sebuah fungsi diusahakan untuk memiliki tugas seminimal mungkin.

Apalagi ada fungsi yang dirasa terlalu panjang dan meng-handle terlalu banyak task, jangan ragu untuk mengekstrak atau memecah fungsi tersebut menjadi beberapa fungsi dengan tugas yang lebih spesifik.

• Penggunaan komentar 

Komentar bukan digunakan setiap kali ada fungsi atau kelas yang baru dibuat. Komentar digunakan hanya ketika ada bagian kode yang memang membutuhkan penjelasan lebih, dan bukan karena kodenya kurang dapat dimengerti. Contoh sederhananya adalah untuk menjelaskan copyright dari sebuah potongan kode.

Catatan penting ketika kita menggunakan komentar adalah untuk turut meng-update komentar tersebut ketika ada bagian kode yang kita ubah. Jika tidak, maka komentar tersebut menjadi berpotensi untuk menyesatkan programmer lainnya.

• Hapus kode yang tidak digunakan

Seringkali kita mengalami trial and error saat mengerjakan kode program kita. Terkadang, ada bagian kode yang tidak kita hapus dan hanya diubah menjadi komentar karena takut kode tersebut akan dibutuhkan di kemudian hari. Bagian kode yang kita jadikan komentar ini disebut juga dengan dead code.

Dalam Clean Code, lebih baik jika kode program kita tidak mengandung dead code. Kalaupun takut akan membutuhkannya nanti, kita bisa menggunakan version control sehingga bagian dead code tadi dapat tersimpan pada history.

Sumber: codingstudio.id