単語を使って変数名を付ける事・Javaソースコードの書き方

変数名の付け方

辞書一般的な単語の意味は、既存の辞書などで調べやすいです。
なので一般的な単語を使って変数名を付けると、その単語の意味から、「変数の働き」を理解するのに役立つでしょう。

名前の付け方の例

以下に、単語を使って変数名を付けている例を書きます。

ActionMapping mapping
mappingが単語です。

このように単語を使うと、その単語を既存の辞書やドキュメント――コンピュータ用語辞典、英語辞典やJava APIドキュメントなど――で、意味を調べられます。
調べた単語の意味より、「変数が取り扱う情報」や「変数の働き」について、より理解できる可能性があります。

「変数の働き」を予想する例

単語によって「変数の働き」を理解できる例。
mappingが、Java2 APIドキュメントのjava.util.HashMapクラスのMapと似ている言葉と予想すると、このmapping変数は、たぶん「何かと何かの情報の対応」を取り扱っている変数だろう、と予想できます。
参考:Java2SE 1.4のドキュメントなど。

単語によって「変数の働き」を理解できない例。
ちなみに英語の辞書では、mappingは地図作成・数学の関数という意味のようです。
「地図作成」という意味からは、「キー」と「値」のマッピングを予想できないでしょう。

単語を使わない例

「単語を使わないで、変数名を付ける」場合についてです。
以下に、わざと単語を使わないで変数名を付けてみます。
例:ActionMapping actMpg

この変数名 actMpg からは、どんな情報を取り扱っているのか?他の人にはわからないことが多いです。
既存の辞書やドキュメントを使っても、この actMpg が何を処理する変数なのか?わかりにくいと思います。

※この記事は、2003年6月当時の記事になります。

コンピューター
この記事をシェアする

グッズ・メモランダム