Seperti yang kita semua tahu, kode program yang bersih tidak hanya memudahkan pembaca untuk memahami maksud program. Tetapi juga memfasilitasi pemeliharaan dan iterasi. Secara umum, ini dapat membawa manfaat berikut untuk pengembangan dan peningkatan kualitas perangkat lunak.
Kode program yang bersih lebih mudah dibaca dan dipahami. Kamu hanya akan menghabiskan lebih sedikit waktu untuk mencari tahu masalah sebenarnya dan lebih banyak waktu untuk memperbaiki, memodifikasi dan memperluas.
Pengembangan program tidak terlepas dari kerjasama. Dan kode bersih sering mengurangi kemungkinan kesalahpahaman di antar tim. Dan dalam jangka panjang, ini juga berarti lebih mengurangi bug dan penyelesaian masalah yang lebih cepat.
Seperti kata pepatah Lebih mudah diucapkan daripada dilakukan. Di satu sisi, menulis kode program yang bersih seperti belajar melukis, memasak, atau memotret – terlihat lebih mudah, tetapi lebih sulit untuk dipraktikkan. Di bawah ini, Labkom99 akan membahas dengan Kamu sepuluh tip untuk menulis kode program yang bagus dan bersih.
1. Tambahkan Nama Deskriptif Pada Kode Program
Variabel, kelas dan fungsi dalam program yang sering dipanggil programmer merupakan antarmuka antara logika yang mendasari aplikasi. Jadi, ketika Kamu menggunakan nama yang ambigu dan non-deskriptif untuk variabel, kelas dan fungsi, Kamu sebenarnya mengacaukan pemahaman pembaca termasuk pengembang itu sendiri tentang logika aplikasi.
Sebagai contoh: Dapatkah Kamu melihat sekilas apa arti sebenarnya dari variabel bernama dxy? Agaknya Kamu harus membaca seluruh blok kode untuk memahami artinya. Namun, untuk variabel distanceBetweenXY, Kamu dan saya dapat langsung memahami apa yang diwakilinya.
Hal yang sama berlaku untuk kelas dan fungsi. Cobalah untuk menghindari penggunaan CalcTan(), alih-alih gunakan CalculateTangent() atau CalcTangentAngle() sesuai kebutuhan. Kesimpulannya, salah satu teknik dasar untuk membuat kode program terlihat rapi adalah dengan menggunakan nama deskriptif.
2. Jadikan Setiap Kelas Atau Fungsi Kode Program Bermakna
Kamu pasti pernah melihat fungsi-fungsi yang panjangnya ratusan bahkan ribuan baris. Tentunya Kamu akan sangat kesulitan untuk menelusuri, memahami bahkan mengeditnya.
Jika ada komentar yang sesuai di antara baris-baris, efek sebenarnya agar kode program lebih mudah di pahami. Mereka dipecah menjadi blok kode untuk tujuan yang berbeda. Di antara mereka, setiap sub-fungsi diatur untuk menyelesaikan tugas tertentu. Setiap kelas juga mewakili konsep tertentu. Kesederhanaan yang dibawa oleh ini lebih cocok untuk penyesuaian lokal dan lebih cocok untuk lokasi masalah dan pemecahan masalah.
Misal dalam praktiknya, fungsi kompleks seperti GetCreditScore() perlu didekomposisi menjadi beberapa fungsi pembantu seperti GetCreditReports(), ApplyCreditHistoryAge(), dan FilterOutstandingMarks(). Kamu dapat merujuk ke artikel ” Cara Memahami Bahasa Coding Untuk Programmer Pemula untuk mempelajari lebih lanjut tentang praktik ini.
3. Hapus Kode Program Yang Tidak Perlu
Saya tidak tahu apakah Kamu pernah memiliki pengalaman ini: dalam proses memperbaiki atau mengoptimalkan sepotong kode, Kamu dengan sengaja berkomentar dan mulai menulis ulang kode baru di bawahnya. Juga, Kamu melakukan ini murni untuk menyimpan kode lama jika Kamu membutuhkannya.
Namun seiring waktu, Kamu mungkin secara tidak sadar mengumpulkan sejumlah besar blok kode program yang dikomentari dan tidak lagi Kamu perlukan. Blok kode ini pasti akan mengacaukan kode sumber Kamu. Selain itu, sebagian besar situasi aktual sering kali terkait kode karena di sekitarnya dan lingkungannya telah diulang. Kode yang dikomentari ini sebenarnya tidak mungkin dipulihkan untuk digunakan.
Tentu saja, praktik mengomentari kode lama ini dapat sepenuhnya digantikan oleh sistem kontrol sumber yang modis saat ini. Kamu dapat mengotomatiskan pekerjaan kontrol sumber secara tepat waktu, akurat dan otomatis dengan menggunakan alat seperti Git atau Mercurial.
Untuk membuat layanan aplikasi ringan dan gesit, Kamu juga dapat secara sadar menggunakan kerangka kerja web yang sudah jadi untuk menghindari pengulangan dan kemudian menggunakan pustaka kelas yang disediakan oleh kerangka kerja untuk menyederhanakan kode Kamu sendiri.
Untuk ini, Kamu dapat merujuk ke artikel 9 Framework PHP Populer Yang Menjadi Andalan Pengembang Web.
4. Keterbacaan
Sebagian besar programmer mengganti kode bersih dengan kode pintar. Hanya berpikir bahwa mengkompres sepuluh baris kode menjadi satu untuk mengurangi ruang layar adalah kode bersih. Faktanya, kode seperti itu tidak selalu mudah dipahami.
Menurut pendapat saya, jenis kode yang memecahkan beberapa masalah khusus ini termasuk dalam kategori kode pintar. Programmer dapat menganggapnya sebagai resep rahasia mereka sendiri. Mereka sering digunakan untuk membuktikan keterampilan pemrograman mereka atau bahkan untuk pamer.
Dan ketika menulis kode bersih, Kamu harus tetap berpikiran terbuka. Jumlah kode bukan satu-satunya ukuran kode bersih. Selain menerapkan fungsionalitas kode Kamu, kode Kamu harus tetap dapat dibaca.
Mungkin Kamu dapat membaca cuplikan kode itu tapi bukan orang lain melainkan diri Kamu sendiri. Lagi pula, tidak ada yang mau menggali lubang dan menambang untuk masa depan mereka.
5. Pertahankan Gaya Pemrograman Yang Konsisten
Setiap programmer memiliki gaya pemrogramannya sendiri. Di sini, saya tidak ingin merekomendasikan atau memaksa Kamu untuk mengikuti apa yang disebut gaya pemrograman terbaik.
Jika Kamu terbiasa menggunakan tanda kurung kurawal antar baris, jika Kamu menginginkan spasi sebelum pemanggilan metode, dan jika Kamu lebih suka tab daripada spasi, ini tidak masalah. Namun, harap jaga agar penggunaan tersebut tetap konsisten.
Sementara itu, jika Kamu akan menggunakan camelCaseNaming sebagai variabel, jangan bingung dengan underscore_naming. Jika Kamu menggunakan GetThisObject() di suatu tempat, jangan gunakan FetchThatObject() di tempat lain.
Selain itu, bahasa pemrograman seperti Python dan C# hadir dengan berbagai pedoman gaya yang perlu diikuti. Termasuk jangan pernah mencampur tab dan spasi.
6. Pilih Arsitektur Yang Tepat
Kamu dapat menggunakan berbagai paradigma dan arsitektur siap pakai untuk membuat proyek yang berbeda. Tentu saja, premisnya adalah tolong pilih yang paling cocok, bukan yang disebut terbaik.
Misalnya, pola Model-View-Controller (MVC) telah menjadi arsitektur paling populer dalam pengembangan web. Bagaimanapun, ini tidak hanya membantu Kamu menjaga struktur kode program Kamu tetap bersih dan masuk akal, tetapi juga meminimalkan upaya pemeliharaan di kemudian hari.
Demikian pula, pola Entity-Component-System (ECS) sangat populer di dunia pengembangan game. Bagaimanapun, ini dapat membantu memodulasi data dan logika game, membuat perawatan lebih mudah dan menghasilkan kode yang lebih mudah dibaca.
7. Kuasai Idiom Dalam Bahasa
Bahasa yang berbeda seperti Python, Java, dan JavaScript yang kita kenal memiliki ide dan kebiasaan pemrograman yang berbeda. Perbedaan di antara mereka sangat besar atau halus.
Logikanya, kita tidak perlu peduli apa jenis objeknya selama kita peduli dengan perilaku dinamisnya. Sementara Java lebih cenderung ke kode verbose dan eksplisit. Setiap bahasa mendorong idiomnya sendiri, seperti pemahaman daftar dengan Python.
Kita juga harus waspada terhadap apa yang disebut anti-pola. Meskipun pola-pola yang dikumpulkan oleh pendahulunya yang memecahkan masalah tertentu dalam pengembangan perangkat lunak akan bermanfaat bagi generasi muda. Tetapi jika itu adalah pola sempit yang hanya efektif untuk kebutuhan khusus, pola tersebut harus dihindari.
8. Pelajari Kode Program Yang Ditulis Oleh Master
Seperti kata pepatah belajar dengan contoh. Jika Kamu ingin menulis kode program yang bersih, Kamu harus terlebih dahulu mengetahui seperti apa tampilan kode yang bersih. Pekerjaan pemrograman dari beberapa pendahulu tingkat master dapat memainkan peran demonstrasi yang baik dan mempelajari ide-ide pemrograman, logika, dan kebiasaan pengkodean di baliknya.
Jelas, Kamu tidak bisa hanya berlari ke markas Microsoft untuk mencuri proyek mereka. Tetapi Kamu dapat menelusuri aplikasi industri khas dan sumber dari berbagai proyek sumber terbuka kapan saja melalui berbagai proyek tampilan pada kode file Github.
Lagi pula, ini juga merupakan tujuan awal dari proyek sumber terbuka untuk memungkinkan lebih banyak orang belajar pemrograman darinya. Kualitas kode Kamu akan meningkat pesat dengan cara komunitas ini saling membantu.
9. Tulis Catatan
Lampirkan komentar atau menulis catatan kutipan adalah salah satu nasihat tertua di dunia pemrograman. Dalam pemrograman yang sebenarnya, programmer pemula menyukainya ketika mereka disarankan untuk meninggalkan komentar sebanyak mungkin. Tentu saja, deskripsi yang tidak perlu, atau bahkan anotasi berlebihan yang mengungkapkan informasi sensitif juga dapat menjadi bumerang.
Bagaimana kita berhenti di situ? Aturan praktis bagi saya adalah bahwa komentar digunakan untuk menjelaskan mengapa kode itu diperlukan. Bukan apa yang sebenarnya dilakukan kode itu. Efeknya cukup jelas jika kode program Kamu cukup bersih.
Misalnya kita dapat menggunakan komentar untuk menjelaskan peringatan menghapusnya akan merusak A, B dan C. Dalam banyak kasus kita harus menggunakan komentar untuk mengungkapkan hal-hal seperti Parameter ini digunakan karena X, Y dan Z. Dan seperti, yang pembaca tidak langsung tahu dari kodenya.
10. Refactoring
Sama seperti mengedit adalah bagian dari proses penulisan. Refactoring harus menjadi bagian dari proses pemrograman. Faktanya, refactoring dapat membantu mengoptimalkan kode program tanpa mempengaruhi perilaku sebenarnya.
Refactoring juga kondusif untuk meningkatkan efisiensi pemeliharaan kode. Pengalaman saya dengan ini adalah, Jangan hanya mengomentari kode yang menurut Kamu membingungkan atau tidak cukup baik, tulis ulang.
Lagi pula, seiring waktu dan pengalaman, Kamu akan meninjau atau memelihara Sepanjang proyek perangkat lunak berjalan. Kamu akan selalu menemukan beberapa kode yang tidak memuaskan saat pertama kali ditulis dan layak untuk di-refactoring.
Kesimpulan
Sama seperti kita belajar bagaimana menulis teks ekspositori singkat, tidak ada patokan yang sempurna untuk membuat kode program yang bersih. Mudah-mudahan, 10 tips yang dibahas Labkom99 di atas akan menjadi panduan praktis bagi Kamu untuk menghindari penulisan kode yang panjang dan membengkak.
