わかりやすい変数名の付け方

プログラミング勉強日記

2020年9月6日
わかりやすいコードを書くために必要不可欠であるわかりやすい変数名の付け方をまとめる。変数名をわかりやすくすることで、読みやすく、コードの間違いにも気づきやすくなる。

PHPの変数の書き方

• PHPの場合は変数は$から始まる
• そのあとは半角英数字とアンダーバー(_)が使用することができる。($のあとにすぐ数字を使うことはできない)

以上のルールに違反すると、実行時にエラーとなってしまう。

また、ルール(命令規則)ではないが以下の決まりもある。

• 大文字と小文字は区別される。
• 変数名を全て大文字にすることもできるが、特別な意味を持つ変数を全て大文字にすることがあるので、全て大文字にはしないほうがいい。

ルールではないが、複数単語になる場合は
単語と単語の間をアンダーバー(_)で区切るか、2語目以降の先頭の文字を大文字にする。

☆ポイント
　複数の単語を使うときはどちら(先頭を大文字にするのか_を使うのか)を決めておく。

複数単語の例

//悪い例
$userid = "123";
$user_name = "Tanaka";
$userGroup = "A";

//良い例
$userID = "123";
$userName = "Tanaka";
$userGroup ="A";

変数名の付け方

　変数の中身は何を格納するのか。中身は何なのかを示したものにする。つまり、変数がどの用途で使われるのかわかりやすい名前にする。
　変数名は長すぎず短すぎずちょうどいい長さにする。
　データベースのテーブルから取得したデータには、テーブルの名前やカラム名をそのまま付けるとわかりやすくなる。

例

//悪い例
$data //何のデータかわからない
$a    //何を格納しているのかわからない
$var  //何の変数(variable)かわからない

//良い例
$error_message //エラーメッセージが格納されている
$user_id       //ユーザのidが格納されている