Penulisan Kode

Clean Code

Prinsip Clean Code banyak diterapkan karena dapat membawa banyak dampak positif pada bisnis. Kode yang bersih dan mudah dipahami dapat mempercepat waktu pengembangan, meningkatkan kualitas kode, serta mengurangi biaya pengembangan. Selain itu, kode yang bersih juga terbukti dapat memudahkan tim untuk bekerja sama dalam mengembangkan aplikasi atau sistem yang lebih kompleks.

Aturan Umun Clean Code

1. Konsistensi Konsistensi adalah salah satu hal yang penting dalam menuliskan kode. Konsistensi dapat meliputi beberapa aspek seperti cara penamaan variabel, pemberian komentar, dll. Dalam penulisan kode, masing-masing bahasa pemrograman serta framework memiliki aturannya masing-masing. Aturan ini disebut sebagai konvensi yang dapat dimanfaatkan oleh para programmer untuk menuliskan kode yang konsisten. Contohnya konvensi penulisan kode untuk Python yang umum digunakan adalah PEP 8, sedangkan untuk Javascript dapat mengikuti panduan yang disediakan oleh Google JavaScript.

2. KISS : Keep It Simple Stupid Kode harus dijaga agar tetap simpel, artinya masing-masing class, function, interface, dan lainnya harus diberi nama yang jelas dan logika yang ada di dalamnya tidak berbelit-belit. Selain itu, penambahan baris kode juga harus dipikirkan secara matang terlebih dahulu. Hal ini agar tidak ada baris kode yang kurang penting dan hanya menambah kompleksitas saja.

3. Tanggung Jawab Pada Aplikasi Pengembangan suatu aplikasi umumnya dikerjakan dalam sebuah tim. Terkadang anggota tim dapat menulis kode yang tidak rapi. Tanggung jawab merapikan kode bukan hanya milik penulis asli dari kode, namun juga tanggung jawab anggota tim lainnya. Dengan saling bekerja sama membuat kode yang clean, maka aplikasi yang dihasilkan pun akan menjadi lebih baik.

Karakteristik Clean Code

1. Penamaan yang mudah dimengerti Beri nama variable yang memang menggambarkan isi dan kegunaan dari variable yang dimaksud. Jangan menamakan variable dengan nama ‘x’. Variable dengan nama seperti ‘x’, ‘i’, atau ‘y’ boleh digunakan jika konteksnya sebagai index pada loop. Gunakan nama yang jelas dan dapat merepresentasikan apa yang dilakukan atau disimpan oleh function atau variable. Nama yang baik harus memberi tahu dengan jelas apa fungsinya, dan bagaimana cara penggunaannya.

2. Buatlah function yang solid Function yang memiliki ketergantungan tinggi dengan function lain memungkinkan adanya error yang tidak terdeteksi. Untuk menghindarinya dapat digunakan teknik pure function. Function dikatakan pure jika:

• Mengembalikan nilai yang di komputasi hanya berdasarkan argumen function.
• Mengembalikan nilai yang sama untuk argumen yang sama, apapun yang terjadi di luar function. Pure function pada umumnya lebih mudah di-test karena tidak dipengaruhi oleh faktor lain.

3. Hindari penggunaan negative conditional Daripada menggunakan variabel yang bernilai negatif, seperti isNotAuthenticated, lebih baik menggunakan variable yang bernilai positif namun diberikan negasi, seperti !isAuthenticated.

4. Berikan komentar singkat dan efisien Penulisan komentar sebaiknya hanya untuk kode yang membutuhkan penjelasan ekstra, seperti ketika menggunakan regex. Mengapa regex membutuhkan penjelasan extra? sebab untuk membaca sebuah regex tidak bisa langsung memahaminya dan langsung mengerti regexnya. Penulisan komentar akan membantu pembaca kode lebih cepat memahaminya. Namun, tetap diutamakan agar kode diperbaiki sehingga mudah dimengerti, dari pada harus memberi komentar pada setiap baris kode.

5. Membuat function yang simpel Setiap function dan class memiliki satu fungsi yang sebisa mungkin tidak bergantung pada kode atau class lain. Alangkah baiknya apabila setiap function hanya melakukan satu hal dan fokus pada hal tersebut. Dengan memfokuskan function, proses debugging juga akan lebih mudah.

6. Erorr and handle exception Saat menulis kode, pastikan apa saja error yang mungkin dapat terjadi. Jangan lupa tambahkan exception dengan handling sesuai dengan Bahasa pemrograman yang kamu tulis.