11

変数の名前は短くても読みやすいものにするのが好きです。

それでも、たとえば、リスト内の要素のインデックスを保持する変数に名前を付けるときは、elemIndex「インデックス」という単語を短縮する適切な (そして普遍的に理解されている) 方法がわからないため、使用する傾向があります。

「インデックス」を短縮する標準的な方法はありますか? それとも、誤解を避けるためにフルスペルにするのが最善ですか?

4

2 に答える 2

10

私の経験では、それは文脈に依存します。通常、何かがインデックスであるかどうかは、それが何に使用されているかから判断できます。

私の経験則は、おおよそ次のようになります。

それが短いループの単なるループ インデックス (例: すべてが一度に画面に収まる) であり、コンテキストがインデックスが何をしているかを読者に知らせる場合、おそらく のような単純なもので回避できます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;
    }
  }
}

コード セクションが大きい場合、または複数のインデックスを使用している場合は、どのリストへのインデックスであるかを示します。

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 が述べたように、読者があなたの略語を理解していると思い込まないでください。略語を使用する場合は、少なくともコメントで宣言してください。

于 2013-04-01T21:22:15.160 に答える