変数名の付け方 - 分かりやすいコードのために

当ページのリンクには広告が含まれています。

ここでは分かりやすいコードのための変数名の付け方を解説します。

変数の命名にも気を使うと、読みやすく！分かりやすいコードを記述することができるので、コードの間違いやバグを防ぐことができます。

変数名の付け方

それでは例示しながら変数名の付け方をみていきます。

変数に何を格納するのか？中身は何なのか？をよく表したものにしましょう。

// 悪い例
$a
$b
$var

悪い例では、変数の中身が何なのか？全くわかりませんね。こういった変数を付けるとコードが分かりにくくなります。

// 良い例
$message
$UserID
$access_token

変数に格納されてる値が何なのか、ひと目で分かるように命名しましょう。

変数名は、短すぎず長すぎず、調度よい長さにしましょう。

// 悪い例
$f = "excel";
$f_e = "exe";
$excel_file_name_group_category = "table";

悪い例では、変数が短かったり、やたらと長かったりで、コードが分かりにくいですね。

※ 長すぎる変数名は打ち間違いの原因になるので、変数名は程よい長さにしましょう。

// 良い例
$file_name = "excel";
$file_extension = "exe";
$file_group = "table";

このように適度な調度よい長さの変数名を付けましょう。

変数名の単語の区切りは明確にしましょう。

// 悪い例
$userid
$filename
$accesstoken

悪い例では、単語間の区切りが明確ではないので、変数が読みづらいですね。

// 良い例
$UserID
$fileName
$access_token

アルファベットを大文字にしたり、アンダーバー（_）を使ったりして、分かりやすい変数名をつけましょう。

変数の名前の付け方は同じ記法を使いましょう。

// 悪い例
$usrid = 'ABCD';
$user_name = 'Taro';
$uGroup = 'Team A';

悪い例では、単語の間にアンダーバーを使ったり、使わなかったり……単語を省略したり、しなかったりで大変わかりにくいですね。

// 良い例
$UserID = 'ABCD';
$UserName = 'Taro';
$UserGroup = 'Team A';

このように変数の命名規則は統一しましょう。