¿Hay alguna excusa para los nombres cortos de variables?

141

Esto se ha convertido en una gran frustración con el código base en el que estoy trabajando actualmente; muchos de nuestros nombres de variables son cortos y no descriptivos. Soy el único desarrollador que queda en el proyecto, y no hay documentación sobre lo que la mayoría de ellos hace, así que tengo que dedicar más tiempo a rastrear lo que representan.

Por ejemplo, estaba leyendo un código que actualiza la definición de una superficie óptica. Las variables establecidas al inicio fueron las siguientes:

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

Tal vez sea solo yo, pero esencialmente no me dijo nada acerca de lo que representaban, lo que hizo que la comprensión del código fuera más difícil. Todo lo que sabía era que era una variable analizada en una fila específica de una tabla específica, en algún lugar. Después de algunas búsquedas, descubrí lo que significaban:

dR = radius
dCV = curvature
dK = conic constant
dDin = inner aperture
dDout = outer aperture
dRin = inner radius
dRout = outer radius

Los cambié de nombre esencialmente a lo que tengo allí. Alarga algunas líneas, pero creo que es un intercambio justo. Sin embargo, este tipo de esquema de denominación se utiliza en gran parte del código. No estoy seguro si es un artefacto de los desarrolladores que aprendieron trabajando con sistemas más antiguos o si hay una razón más profunda detrás de eso. ¿Existe una buena razón para nombrar las variables de esta manera o tengo justificación para actualizarlas a nombres más descriptivos a medida que las encuentro?

    
pregunta KChaloux 24.11.2012 - 20:22
fuente

0 respuestas

Lea otras preguntas en las etiquetas