Ini menjadi frustrasi besar dengan basis kode yang saat ini saya kerjakan; banyak nama variabel kami pendek dan tidak deskriptif. Saya satu-satunya pengembang yang tersisa di proyek ini, dan tidak ada dokumentasi mengenai apa yang dilakukan kebanyakan dari mereka, jadi saya harus menghabiskan waktu ekstra untuk melacak apa yang mereka wakili.
Sebagai contoh, saya membaca beberapa kode yang memperbarui definisi permukaan optik. Variabel yang ditetapkan pada awal adalah sebagai berikut:
double dR, dCV, dK, dDin, dDout, dRin, dRout
dR = Convert.ToDouble(_tblAsphere.Rows[0].ItemArray.GetValue(1));
dCV = convert.ToDouble(_tblAsphere.Rows[1].ItemArray.GetValue(1));
... and so on
Mungkin hanya saya, tetapi pada dasarnya tidak memberi tahu saya apa yang mereka wakili, yang membuat memahami kode semakin sulit. Yang saya tahu adalah bahwa itu adalah variabel yang diuraikan baris tertentu dari tabel tertentu, di suatu tempat. Setelah beberapa pencarian, saya menemukan apa artinya:
dR = radius
dCV = curvature
dK = conic constant
dDin = inner aperture
dDout = outer aperture
dRin = inner radius
dRout = outer radius
Saya mengganti nama mereka menjadi apa yang saya miliki di sana. Itu memperpanjang beberapa garis, tapi saya merasa itu adalah trade off yang adil. Namun skema penamaan semacam ini digunakan di banyak kode. Saya tidak yakin apakah itu artefak dari pengembang yang belajar dengan bekerja dengan sistem yang lebih lama, atau jika ada alasan yang lebih dalam di baliknya. Apakah ada alasan yang baik untuk menamai variabel dengan cara ini, atau apakah saya dibenarkan memperbarui mereka menjadi nama yang lebih deskriptif saat saya menjumpai variabel?
dK = conic constant.
