[Gamelog] Memberi Nama Variabel dan Fungsi Dengan Baik
Beberapa waktu lalu saya membuka kembali kodingan sebuah proyek yang dikerjakan kira-kira satu tahun yang lalu. Proyek ini saya buka kembali karena waktu itu memang belum selesai dikerjakan karena satu dan lain hal. Akhirnya kemarin harus membuka kembali dan jujur, saya yang ngoding sendiri pusing bacanya.
Ada yang bilang membaca kodingan orang lain itu merupakan hal yang sulit. Ternyata baca kodingan diri sendiri yang sudah lama tidak dibuka juga merupakan hal yang sulit. Ini dikarenakan pembeliran nama untuk variabel dan fungsi yang saya buat kurang baik. Sistem penamaannya sangat ambigu sehingga saya suka bingung kalo lagi ngetrack algoritma yang dipakai untuk menjalankan suatu aksi.
public class Terbang{ float tampung1; float tinggi; bool benarTidak; void Naik () { } }
Pemilihan nama yang baik harusnya konsisten dan deskriptif. Menurut saya sih tidak apa nama variabel atau fungsi agak panjang, yang penting jelas ketika dibaca. Demikian juga kalau membuat nama kelas. Sebaiknya dibuat agar jelas sejelas-jelasnya sehingga ketika ingin dibaca lagi akan lebih mudah.
public class PowerUpFlying{ //Power up yang dapat digunakan oleh karakter untuk terbang float currentHeight; //menyimpan tinggi awal sebelum karakter terbang float lastHeight; //menyimpan tinggi akhir untuk karakter terbang bool isFlying; //jika karakter terbang = true //mengaktifkan power up untuk terbang ketika power up digunakan void FlyActivated () { } }
Mungkin selain penamaan yang baik, kita juga harus rajin membuat comment di dalam kode kita yang bertujuan untuk menjelaskan lebih detil variabel tersebut untuk apa, fungsi yang kita buat untuk melakukan apa, kelas yang kita buat akan digunakan untuk apa, dan lain sebagainya. Ketika menulis kode, kita gak akan kepikiran untuk ngebuat komen karena pasti ngerasa bakal inget kok. Iya inget kalau kita ngoding non stop sampai proyeknya beres, lalu pas udah beres gak akan dibuka lagi seumur hidup kodingannya. Kenyataannya gak begitu, kadang kita harus switch dari satu proyek ke proyek lain, kadang harus buka proyek yang sudah lama, atau kodingan kita harus bisa dimengerti oleh orang lain.
Tinggalkan Balasan