Điều này đã trở thành một sự thất vọng lớn với cơ sở mã mà tôi hiện đang làm việc; nhiều tên biến của chúng tôi là ngắn và không mô tả. Tôi là nhà phát triển duy nhất còn lại trong dự án và không có tài liệu nào về hầu hết những gì họ làm, vì vậy tôi phải dành thêm thời gian để theo dõi những gì họ đại diện.
Ví dụ, tôi đã đọc qua một số mã cập nhật định nghĩa của bề mặt quang học. Các biến được đặt khi bắt đầu như sau:
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
Có lẽ đó chỉ là tôi, nhưng về cơ bản nó không cho tôi biết gì về những gì họ thể hiện, điều này khiến cho việc hiểu mã trở nên khó khăn hơn. Tất cả những gì tôi biết là đó là một biến được phân tách ra một hàng cụ thể từ một bảng cụ thể, ở đâu đó. Sau khi tìm kiếm, tôi phát hiện ra ý nghĩa của chúng:
dR = radius
dCV = curvature
dK = conic constant
dDin = inner aperture
dDout = outer aperture
dRin = inner radius
dRout = outer radius
Tôi đổi tên chúng thành những gì tôi có trên đó. Nó kéo dài một số dòng, nhưng tôi cảm thấy như đó là một sự đánh đổi công bằng. Tuy nhiên, loại lược đồ đặt tên này được sử dụng trong suốt rất nhiều mã. Tôi không chắc liệu đó có phải là vật phẩm từ các nhà phát triển đã học bằng cách làm việc với các hệ thống cũ hơn hay không, nếu có lý do sâu xa hơn đằng sau nó. Có một lý do chính đáng để đặt tên biến theo cách này hay tôi có lý khi cập nhật chúng thành tên mô tả hơn khi tôi bắt gặp chúng?
dK = conic constant.
