Z mojego doświadczenia wynika, że zależy to od kontekstu. Zazwyczaj mogę stwierdzić, czy coś jest indeksem od tego, do czego jest używane, więc często jestem bardziej zainteresowany tym, co jest indeksem.
Moja zasada idzie mniej więcej tak:
Jeśli jest to tylko wskaźnik pętla w krótkiej pętli (np: wszystko mieści się na ekranie na raz) i kontekst informuje czytelnika, co indeks robi, wtedy prawdopodobnie możesz uciec z czymś prostym, takim jak i.
Przykład: wartości odcięcia obraz
//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;
}
}
}
Jeżeli sekcja kodu jest większa, lub masz wiele indeksami dzieje, wskazać, które wymienione jest indeksem do:
File[] files_in_dir = ...;
int num_files = files_in_dir.length();
for (int fileIdx = 0; fileIdx < num_files; fileIdx++) { //for each file in dir.
...
}
Jeżeli jednak indeks jest rzeczywiście ważny dla znaczenia kodu, a następnie dokładnie go określić, na przykład:
int imageToDeleteIdx = 3; //index of the image to be deleted.
image_list.delete(imageToDeleteIdx);
Jednak kod należy uważać za "napisz raz, czytaj wiele", a twój wysiłek powinien zostać przydzielony jako taki; tj .: mnóstwo na piśmie, więc czytanie jest łatwe. W tym celu, jak wspomniał Brad M, nigdy nie zakładaj, że czytelnik rozumie twoje skróty. Jeśli zamierzasz używać skrótów, to przynajmniej zadeklaruj je w komentarzach.
Nigdy nie zakładaj, że inny programista zrozumie Twoje skróty. Dla dobra ludzkości, przeliteruj je. –
@BradM: Więc użycie 'Idx' jak Alan jest również złym pomysłem? –
@mareser Jeśli jesteś o to surowy, to tak, to zły pomysł.Staram się jedynie skracać rzeczy, które są naprawdę długie, lub powinny być wyraźnie widoczne z kontekstu, aw każdym przypadku skomentować pierwsze/kluczowe wystąpienie tego skrótu w sekcji. W praktyce, chociaż unikanie skrótów jest dobrą zasadą, istnieje punkt, w którym może to negatywnie wpłynąć na czytelność kodu (i zwiększyć liczbę literówek). To kwestia osądu ... lub trzymania się przewodnika po swojej organizacji. – Alan