variables - 变量名 : How to abbreviate "index"?

Question

我喜欢保持变量的名称简短但可读。

尽管如此，例如，当命名保存某个列表中元素索引的变量时，我倾向于使用 elemIndex因为我不知道缩写“索引”这个词的正确(并且普遍理解)的方式。

是否有缩写“索引”的规范方式？还是最好将其完整拼写以避免误解？

Answer 1

根据我的经验，这取决于上下文。通常我可以从它的用途来判断某个东西是否是一个索引，所以我通常更想知道它是什么的索引。

我的经验法则大致如下:

如果它只是一个短循环中的循环索引(例如:一次全部显示在屏幕上)并且上下文通知读者索引在做什么，那么您可能可以使用诸如 i 之类的简单方法。 .

示例:对图像进行阈值处理

//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;
    }
  }
}

如果代码部分更大，或者您有多个 indeces，请指出它是哪个列表的索引:

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

但是，如果索引实际上对代码的含义很重要，则完全指定它，例如:

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

然而，代码应该被认为是“一次编写，多次阅读”，你的努力应该这样分配；即:写作很多，所以阅读很容易。为此，正如 Brad M 所提到的，永远不要假设读者理解您的缩写。如果您打算使用缩写，请至少在注释中声明它们。