Nomi di variabili: come abbreviare "indice"?

Question

Mi piace mantenere i nomi delle mie variabili brevi ma leggibili.

Ancora, quando, ad esempio, nominando la variabile che contiene l'indice di un elemento in qualche elenco, tendo ad usare elemIndex perché non conosco un modo corretto (e universalmente compreso) di abbreviare la parola "indice ".

Esiste un modo canonico di abbreviare "indice"? O è meglio scriverlo per intero per evitare equivoci?

Answer 1

Nella mia esperienza dipende dal contesto. Tipicamente posso dire se qualcosa è un indice da quello per cui è usato, quindi sono spesso più interessato a sapere di che indice è.

mia regola va grosso modo così:

Se è solo un indice del ciclo in un breve ciclo (ad esempio: tutto si inserisce sullo schermo in una sola volta) e il contesto informa il lettore che cosa l'indice sta facendo, allora puoi probabilmente farla franca con qualcosa di semplice come i.

Esempio: controllo della soglia di un'immagine

//For each pixel in the image, threshold it 
for (int i = 0; i < height; i++) { 
    for (int j = 0; j < width; j++) { 
    if (image[i][j] < 128) { 
     image[i][j] = 0; 
    } else { 
     image[i][j] = 255; 
    } 
    } 
} 

Se la sezione di codice è più grande, o si dispone di più indici in corso, indicare quali elencare è un indice in:

File[] files_in_dir = ...; 
int num_files = files_in_dir.length(); 
for (int fileIdx = 0; fileIdx < num_files; fileIdx++) { //for each file in dir. 
    ... 
} 

Se, tuttavia l'indice è effettivamente importante per il significato del codice, quindi specificarlo completamente, ad esempio:

int imageToDeleteIdx = 3; //index of the image to be deleted. 
image_list.delete(imageToDeleteIdx); 

Tuttavia il codice dovrebbe essere considerato "scrivi una volta, leggi molti" e il tuo sforzo dovrebbe essere assegnato come tale; cioè: molto sulla scrittura, quindi la lettura è facile. A tal fine, come menzionato da Brad M, non assumere mai che il lettore capisca le tue abbreviazioni. Se hai intenzione di usare le abbreviazioni, almeno le dichiari nei commenti.

Answer 2

Attenersi a convenzioni consolidate e ben note. Se usi le convenzioni comuni, le persone avranno meno sorprese quando leggono il tuo codice.

I programmatori sono abituati a utilizzare molte convenzioni della matematica. Per esempio. in matematica tipicamente etichettiamo gli indici:

i, j, k 

Mentre ad es. le coordinate sono indicate con lettere come:

x, y, z 

Questo dipende naturalmente dal contesto. Per esempio. utilizzando i per indicare un indice globale sarebbe una idea terribile. Usare nomi brevi per variabili molto locali e nomi più lunghi per più funzioni e variabili globali, è una buona regola empirica.

Per me questo stile è stato influenzato da Rob Pike, che elabora di più su questo here. Come qualcuno con un interesse per la progettazione e l'esperienza dell'interfaccia utente, ho anche scritto più ampiamente su questo.