Poin Penting
1. Kode bersih itu mudah dibaca, sederhana, dan ekspresif
Kode bersih selalu terlihat seperti ditulis oleh seseorang yang peduli.
Kejelasan adalah kunci. Kode bersih ditandai dengan keterbacaan dan kesederhanaannya. Kode tersebut harus mudah dipahami, dimodifikasi, dan dipelihara oleh programmer lain. Ini meliputi penggunaan nama yang jelas dan bermakna, menjaga fungsi dan kelas agar kecil dan fokus, serta mengorganisasi kode secara logis.
Kode ekspresif menyampaikan maksud. Kode bersih harus mampu mengungkapkan niat programmer tanpa perlu komentar yang berlebihan. Hal ini dicapai melalui pemilihan nama yang tepat, fungsi kecil yang melakukan satu hal dengan baik, dan struktur keseluruhan yang jelas. Kode itu sendiri harus bercerita, sehingga pembaca mudah mengikuti logika dan tujuan setiap komponennya.
Perbaikan berkelanjutan sangat penting. Menulis kode bersih adalah proses yang terus-menerus dan membutuhkan perhatian serta refaktorisasi secara rutin. Programmer sebaiknya mengikuti Aturan Pramuka: "Tinggalkan tempat perkemahan lebih bersih daripada saat kamu menemukannya." Artinya, selalu cari kesempatan untuk meningkatkan kejelasan dan struktur kode, meskipun hanya sedikit, setiap kali melakukan perubahan atau penambahan.
2. Nama yang bermakna meningkatkan kejelasan dan pemeliharaan kode
Nama variabel, fungsi, atau kelas harus menjawab semua pertanyaan besar. Harus memberi tahu mengapa ia ada, apa yang dilakukannya, dan bagaimana cara menggunakannya.
Pilih nama yang deskriptif. Nama harus bisa menjelaskan dirinya sendiri dan mengungkapkan maksud di balik variabel, fungsi, dan kelas. Hindari nama satu huruf, singkatan, atau kode yang membingungkan sehingga memerlukan pemetaan mental untuk memahami tujuannya.
Gunakan konvensi penamaan secara konsisten. Terapkan dan patuhi konvensi penamaan standar sesuai bahasa pemrograman dan tim Anda. Contohnya:
- CamelCase untuk nama kelas (misal: CustomerOrder)
- camelCase untuk nama variabel dan fungsi (misal: totalAmount)
- ALL_CAPS untuk konstanta (misal: MAX_SIZE)
Hindari informasi yang menyesatkan dan kebisingan. Jangan gunakan nama yang bisa membingungkan atau menyesatkan. Misalnya, jangan gunakan 'list' dalam nama variabel jika itu bukan sebuah List. Juga, hindari kata-kata yang berlebihan atau tidak bermakna seperti 'data' atau 'info' jika tidak menambah nilai.
3. Fungsi harus kecil, melakukan satu hal, dan beroperasi pada satu tingkat abstraksi
Fungsi harus melakukan satu hal. Mereka harus melakukannya dengan baik. Mereka hanya harus melakukannya.
Jaga fungsi agar kecil. Fungsi idealnya tidak lebih dari 20 baris. Ini membuatnya lebih mudah dibaca, dipahami, dan dipelihara. Fungsi yang kecil juga lebih mudah diberi nama yang tepat, diuji, dan digunakan ulang.
Prinsip tanggung jawab tunggal. Setiap fungsi harus memiliki satu tujuan yang jelas. Jika sebuah fungsi melakukan banyak hal, sebaiknya dipecah menjadi fungsi-fungsi yang lebih kecil dan fokus. Ini meningkatkan keterbacaan dan membuat kode lebih modular serta mudah diubah.
Tingkat abstraksi yang konsisten. Dalam sebuah fungsi, semua operasi harus berada pada tingkat abstraksi yang sama. Mencampur logika tingkat tinggi dengan detail tingkat rendah membuat fungsi sulit dipahami dan dipelihara. Gunakan teknik refaktorisasi "Extract Method" untuk memisahkan tingkat abstraksi yang berbeda ke fungsi terpisah.
4. Komentar harus minimal dan benar-benar diperlukan
Penggunaan komentar yang tepat adalah untuk mengkompensasi kegagalan kita dalam mengekspresikan diri melalui kode.
Kode harus bisa menjelaskan dirinya sendiri. Kode yang ditulis dengan baik, nama yang jelas, dan struktur yang rapi seringkali menghilangkan kebutuhan komentar. Sebelum menambahkan komentar, pertimbangkan apakah Anda bisa merombak kode agar maksudnya lebih jelas.
Gunakan komentar dengan bijak. Komentar yang baik menjelaskan mengapa sesuatu dilakukan, bukan bagaimana caranya. Komentar harus memberikan konteks atau klarifikasi yang tidak bisa diungkapkan hanya dengan kode. Jenis komentar yang berguna meliputi:
- Komentar legal (hak cipta, lisensi)
- Penjelasan maksud atau algoritma
- Peringatan konsekuensi
- Komentar TODO (digunakan dengan hemat)
Hindari komentar yang berlebihan atau menyesatkan. Jangan tulis komentar yang hanya mengulang apa yang sudah jelas dari kode. Komentar yang usang atau salah lebih buruk daripada tidak ada komentar sama sekali karena bisa menyesatkan pembaca. Selalu tinjau dan perbarui komentar bersamaan dengan kode yang dijelaskan.
5. Format yang tepat meningkatkan keterbacaan kode
Format kode adalah tentang komunikasi, dan komunikasi adalah prioritas utama pengembang profesional.
Gaya konsisten itu penting. Tetapkan dan ikuti gaya format yang konsisten di seluruh basis kode Anda. Ini meliputi:
- Indentasi
- Pemisah baris
- Penempatan kurung kurawal
- Spasi di sekitar operator dan kata kunci
Format vertikal. Susun kode secara vertikal untuk meningkatkan keterbacaan:
- Dekatkan konsep yang terkait
- Pisahkan konsep yang tidak terkait
- Deklarasikan variabel dekat dengan penggunaannya
- Tempatkan fungsi yang saling bergantung berdekatan
Format horizontal. Jaga agar baris kode tidak terlalu panjang (biasanya 80-120 karakter) agar tidak perlu menggulir horizontal. Pecah pernyataan panjang menjadi beberapa baris secara logis. Gunakan spasi putih untuk memisahkan blok logis dalam satu baris.
6. Objek dan struktur data memiliki tujuan yang berbeda
Objek menyembunyikan data mereka di balik abstraksi dan mengekspos fungsi yang beroperasi pada data tersebut. Struktur data mengekspos data mereka dan tidak memiliki fungsi bermakna.
Objek vs struktur data. Objek mengenkapsulasi data dan mengekspos perilaku melalui metode. Mereka cocok untuk menambah tipe baru (kelas) tanpa mengubah perilaku yang ada. Struktur data, sebaliknya, mengekspos data dan tidak memiliki perilaku signifikan. Mereka cocok untuk menambah perilaku baru tanpa mengubah tipe data yang ada.
Pilih pendekatan yang tepat. Gunakan objek ketika Anda ingin sering menambah tipe baru tetapi menjaga perilaku tetap stabil. Gunakan struktur data ketika Anda ingin sering menambah perilaku baru tetapi menjaga tipe tetap stabil. Memahami perbedaan ini membantu merancang sistem yang lebih fleksibel dan mudah dipelihara.
Hukum Demeter. Untuk objek, ikuti Hukum Demeter: sebuah metode hanya boleh memanggil metode pada:
- Objek itu sendiri
- Parameter yang diterima
- Objek yang dibuatnya
- Komponen langsung dari objek tersebut
Prinsip ini membantu mengurangi keterkaitan antar bagian sistem.
7. Penanganan kesalahan harus bersih dan informatif
Penanganan kesalahan itu penting, tapi jika mengaburkan logika, itu salah.
Gunakan pengecualian daripada kode kesalahan. Pengecualian memberikan cara yang lebih bersih untuk menangani kesalahan dibandingkan kode kesalahan tradisional. Mereka memisahkan logika penanganan kesalahan dari kode utama, sehingga keduanya lebih mudah dipahami dan dipelihara.
Buat pesan kesalahan yang informatif. Pesan kesalahan harus memberikan konteks yang cukup untuk memahami apa yang salah dan di mana. Sertakan detail relevan seperti:
- Operasi apa yang sedang dicoba
- Kesalahan spesifik apa yang terjadi
- Nilai atau informasi status yang relevan
Tulis blok try-catch-finally terlebih dahulu. Saat menulis kode yang bisa melempar pengecualian, mulailah dengan menulis blok try-catch-finally. Ini membantu memastikan kode tahan terhadap kesalahan sejak awal dan kasus kesalahan dipertimbangkan dengan baik.
8. Unit test sangat penting untuk menjaga kode tetap bersih
Kode pengujian sama pentingnya dengan kode produksi.
Tulis tes terlebih dahulu. Ikuti praktik Test-Driven Development (TDD):
- Tulis tes yang gagal
- Tulis kode minimum untuk membuat tes lulus
- Refaktorisasi kode sambil menjaga tes tetap lulus
Pendekatan ini memastikan kode Anda dapat diuji sejak awal dan membantu mendorong desain yang baik.
Jaga tes tetap bersih. Terapkan standar kebersihan yang sama pada kode tes seperti pada kode produksi. Tes yang bersih adalah:
- Mudah dibaca
- Mudah dipelihara
- Dapat dipercaya
Ikuti prinsip F.I.R.S.T untuk tes:
- Fast: Tes harus berjalan cepat
- Independent: Tes tidak bergantung satu sama lain
- Repeatable: Tes dapat diulang di lingkungan mana pun
- Self-Validating: Tes menghasilkan output boolean (lulus/gagal)
- Timely: Tes ditulis tepat sebelum kode produksi
9. Kelas harus kecil, fokus, dan mengikuti Prinsip Tanggung Jawab Tunggal
Aturan pertama kelas adalah harus kecil. Aturan kedua adalah harus lebih kecil dari itu.
Jaga kelas tetap fokus. Sebuah kelas harus memiliki satu tanggung jawab yang jelas. Jika Anda tidak bisa menjelaskan tujuan kelas dalam sekitar 25 kata tanpa menggunakan "dan" atau "atau," kemungkinan kelas tersebut melakukan terlalu banyak hal.
Usahakan kohesi tinggi. Metode dan variabel dalam kelas harus saling terkait erat dan bekerja sama untuk memenuhi tanggung jawab kelas. Kohesi rendah biasanya menandakan kelas mencoba melakukan terlalu banyak dan sebaiknya dipecah.
Prinsip Open-Closed. Rancang kelas agar terbuka untuk ekstensi tapi tertutup untuk modifikasi. Ini sering melibatkan penggunaan abstraksi dan antarmuka agar fungsionalitas baru bisa ditambahkan tanpa mengubah kode yang sudah ada.
10. Konkruensi memerlukan desain dan implementasi yang hati-hati
Menulis program konkuren yang bersih itu sulit—sangat sulit.
Pahami tantangan konkruensi. Pemrograman konkuren membawa kompleksitas seperti:
- Kondisi balapan
- Deadlock
- Masalah kelangsungan hidup (liveness)
- Dampak performa
Pisahkan kode terkait konkruensi. Isolasikan kode yang berhubungan dengan konkruensi. Ini memudahkan pemahaman, pengujian, dan pemeliharaan bagian konkuren dan non-konkuren dari sistem Anda.
Gunakan pustaka dan kerangka kerja yang ada. Manfaatkan pustaka dan kerangka kerja konkruensi yang sudah teruji (misal: java.util.concurrent di Java) daripada mencoba mengimplementasikan kontrol konkruensi tingkat rendah sendiri. Alat ini sudah dioptimalkan dan diuji untuk pola konkruensi umum.
Tulis tes yang menyeluruh. Menguji kode konkuren itu menantang tapi sangat penting. Tulis tes yang:
- Membuat banyak thread
- Mengubah waktu dan penjadwalan
- Dijalankan berulang kali untuk meningkatkan peluang menemukan masalah yang tidak konsisten
- Menggunakan alat seperti thread sanitizer dan analisis statis untuk membantu mengidentifikasi bug konkruensi potensial
Ringkasan Ulasan
Clean Code sangat dihargai sebagai bacaan penting bagi para pengembang perangkat lunak, karena memberikan wawasan berharga tentang cara menulis kode yang mudah dibaca dan dipelihara. Meskipun dipuji atas saran praktisnya mengenai konvensi penamaan, desain fungsi, dan pengujian, beberapa pembaca merasa buku ini terlalu berfokus pada Java dan terkadang memberikan rekomendasi yang terkesan ekstrem. Studi kasus dalam buku ini mendapat tanggapan beragam; ada yang menganggapnya sangat membantu, namun ada pula yang kurang terkesan. Meski memiliki kekurangan, banyak pengembang menganggap buku ini sebagai bacaan wajib yang telah secara signifikan meningkatkan praktik pengkodean dan pemahaman mereka tentang keahlian dalam pengembangan perangkat lunak.
Orang Juga Membaca
Unduh PDF
Unduh EPUB
.epub ideal untuk membaca ebook di ponsel, tablet, dan e-reader.