C'è una scusa per nomi di variabili brevi?

141

Questa è diventata una grande frustrazione per il codice base al quale sto lavorando attualmente; molti dei nostri nomi variabili sono brevi e non descrittivi. Sono l'unico sviluppatore rimasto nel progetto, e non c'è documentazione su ciò che la maggior parte di loro fa, quindi devo dedicare più tempo a rintracciare ciò che rappresentano.

Ad esempio, stavo leggendo un po 'di codice che aggiorna la definizione di una superficie ottica. Le variabili impostate all'inizio erano le seguenti:

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

Forse sono solo io, ma non mi ha detto sostanzialmente nulla di ciò che hanno rappresentato, il che ha reso difficile la comprensione del codice. Tutto quello che sapevo era che era una variabile che analizzava una riga specifica da una tabella specifica, da qualche parte. Dopo alcune ricerche, ho scoperto cosa intendevano:

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

Li ho ribattezzati essenzialmente per quello che ho lassù. Allunga alcune linee, ma mi sembra che sia un buon compromesso. Tuttavia, questo tipo di schema di denominazione viene utilizzato in gran parte del codice. Non sono sicuro che si tratti di un artefatto di sviluppatori che hanno imparato lavorando con sistemi meno recenti o se c'è una ragione più profonda dietro di esso. C'è un buon motivo per denominare le variabili in questo modo, o sono giustificato nell'aggiornarle a nomi più descrittivi mentre li trovo?

    
posta KChaloux 24.11.2012 - 20:22
fonte

0 risposte

Leggi altre domande sui tag