はじめのうちは変数名って迷いますよね。今回はそんなコーディングの際における変数名のおすすめな命名方法について解説いたします。(今回はJavaで例を示しますが、Java以外の言語でも同じルールでよいかと思います。)
可読性の高いコードを記述するためには、意味のある変数名を使用することが重要です。特に初心者の方にとっては、変数名の付け方を早期に習得しておくことが、プログラミングの理解を深める助けとなります。
Table of Contents
1. 変数名とは
変数名とは、プログラム内で値を一時的に保持する「記号的な名前」のことを指します。以下の例をご覧ください。
int age = 25;
String name = "Taro";
この場合、age
および name
が変数名に該当いたします。
2. 命名に関する基本ルール
2.1 意味のある英単語を用いる
変数が保持する値の意味が一目で分かるような英単語を使用することが推奨されます。一文字の変数名や意味の曖昧な略語は避けましょう。
不適切な例:
int a = 25;
String n = "Taro";
適切な例:
int age = 25;
String name = "Taro";
2.2 キャメルケース
Javaでは、変数名に「キャメルケース」と呼ばれる表記法を用いるのが一般的です。これは、最初の単語は小文字、2語目以降の語頭を大文字とする記法です。多くの現場で採用されています。
例:
int itemCount;
String userEmail;
2.3 略語の使用は避ける
略語は読み手によって解釈が異なる場合があり、混乱の原因となるため、極力避けることが望ましいです。
不適切な例:
int cnt = 10; //「count」の略
適切な例:
int totalCount = 10;
2.4 値の性質に適した名前を付ける
変数が何を意味するのかが直感的に理解できるよう、対象とするデータの性質に即した名前を付けることが重要です。
例:
- ユーザー名 →
userName
- 年齢 →
age
- 残り時間(秒)→
remainingSeconds
2.5 真偽値(boolean型)には is/has/should などの接頭辞を使用する
真偽値を表す変数には、is
などの論理的意味を表す接頭辞を付けることで、意図が明確になります。
例:
boolean isLoggedIn = true; //ログインされたかどうか
2.6 ハンガリアン記法は控える
ハンガリアン記法とは、型の種類を変数名の先頭に記載する記法のことです。一時期はよく使用されていたようですが、型が変更になった際の修正コストなどがかかることから、現在では非推奨となっている現場が多いようです。
不適切な例:
Date dtInsertDate = "2024/11/11";
String strCountryName = "Japan";
適切な例:
Date insertDate = "2024/11/11";
String countryName = "Japan";
3. よくある命名ミスと改善案
不適切な名前 | 問題点 | 改善案 |
---|---|---|
data | 内容が抽象的すぎる | userData , itemList |
temp | 意味が不明瞭で汎用的すぎる | tempFilePath 、temporaryValue |
x , y | 数学的な文脈以外では不明瞭 | width , height など |
4. おわりに
変数名の付け方は、コードの可読性・保守性を大きく左右する要素です。自分のためだけではなく、将来的に誰かが保守をすることになってもすぐわかるような変数名をつけてあげましょう。