変数名の付け方

java

コーディング規約関連で、
変数名の付け方も、ちょっと紹介。

コーディング規約にあるもの

　　変数、メソッド名は小文字単語を使う

  • 二単語以上になる場合、二単語目移行の一文字目は大文字にする

　　ex) veryLongWord

  • 定数は、大文字をアンダーバーでつなげる

　　ex) static final int CONSTANT_VALUE = 3;

これを守るのは、絶対なんですが
それ以外でも心がける事はあります。

規約ではないが心がけるべきもの

  • 大域変数は、分かりやすい名前にする

大域変数は、プログラムの中のどこにでも
突然でてくるので、すぐに何を表しているか分かるように
分かりやすい名前にした方がいいです。
Javaでは、あんまり大域変数自体使わないかもなんですが、
jigletを作る時には、よく使うので心がけましょう。

  • 統一性をもたせる

コーディング規約を守ることで、ある程度統一性はもてていますが
それ以外のところでも、統一性を持たせる事に気をつけましょう。
例えばメソッド名だと、1文字目を小文字で、動詞＋名詞の形にする。
実際に自分のソースを見て思ったことがある例だと、
写真のデータを入れる変数を、場合に応じて、
photoにしたり、picにしたりしていまいた(;´Д｀)
これだと他人がソースを見たら、何故使い分けてるの??ってなっちゃいます。
○○Picと△△Picのように付けるのが良いです。

  • 正確な英語を使う

よく分からない単語があったら、とりあえず翻訳する事が多いので
正しい単語にしてくれると嬉しいです。
ローマ字でも意味は分かるのですが、やはり多くの人に見られるソースとしては×ですね。
プログラム独自の、存在しない単語を使うんじゃねえよ！
って怒ってる人の記事を見た記憶がありますｗ

その他

あと変数命名とは関係ないのですが、
これは何に使っている変数なのか、コメント文があると分かりやすくて嬉しいです。
メソッド名は、それだけで何をしているか分かるように付けるのが当然なのですが、
変数名は、あまり長くできないので中々何の変数なのか読み取るのが難しい・・・。
と言っても、一目で分かるような所にコメント文を打つのも、しつこいのでNGになります。