Existe uma desculpa para nomes de variáveis curtas?

141

Isso se tornou uma grande frustração com a base de código em que estou trabalhando atualmente; muitos de nossos nomes de variáveis são curtos e não descritivos. Eu sou o único desenvolvedor deixado no projeto, e não há documentação sobre o que a maioria deles faz, então tenho que gastar tempo extra rastreando o que eles representam.

Por exemplo, eu estava lendo algum código que atualiza a definição de uma superfície óptica. As variáveis definidas no início foram as seguintes:

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

Talvez seja só eu, mas não me disse nada sobre o que eles representavam, o que dificultou a compreensão do código. Tudo o que eu sabia era que era uma variável analisada em uma linha específica de uma tabela específica, em algum lugar. Após algumas pesquisas, descobri o que elas significavam:

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

Eu os renomeiei para essencialmente o que tenho lá em cima. Isso aumenta algumas linhas, mas eu sinto que isso é justo. Esse tipo de esquema de nomenclatura é usado em todo o código, no entanto. Não tenho certeza se é um artefato de desenvolvedores que aprenderam trabalhando com sistemas mais antigos ou se há uma razão mais profunda por trás disso. Existe uma boa razão para nomear variáveis dessa maneira, ou estou justificado em atualizá-las para nomes mais descritivos à medida que eu as encontro?

    
por KChaloux 24.11.2012 / 20:22
fonte

0 respostas